docs-discoverability-audit

Audits repository documentation for navigation, internal linking, and search indexability issues.

Updated Jul 7, 2026
One-click install
npx skills add https://github.com/vmitsaras/Agent-Skills --skill docs-discoverability-audit-vmitsaras
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-discoverability-audit
Source: https://github.com/vmitsaras/Agent-Skills/tree/main/skills/docs-seo/docs-discoverability-audit
Command: npx skills add https://github.com/vmitsaras/Agent-Skills --skill docs-discoverability-audit-vmitsaras

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation often exists but remains hard to find: READMEs lack clear entry points, pages are orphaned or duplicated, and sitemap, canonical, or robots misconfigurations block indexing. This Skill audits documentation as a connected information system so users and search engines can actually reach the right pages. ## Core Features & Use Cases - Documentation mapping: Inventories README entry points, navigation configs, sidebars, and page hierarchies to find orphaned, duplicated, or misplaced pages. - Findability and internal-link review: Checks titles, headings, URLs, anchors, breadcrumbs, and cross-links between guides, examples, and API reference. - Technical SEO checks: Reviews sitemaps, robots directives, canonical URLs, redirects, and noindex rules, separating confirmed findings from unverified assumptions. - Use Case: A maintainer of an open-source package notices users repeatedly ask where the installation guide is. Run this audit to map the docs, find that the README links to an obsolete page, and receive a prioritized fix plan. ## Quick Start Audit the documentation in this repository for discoverability problems and produce a prioritized findings report with a recommended change plan.

Frequently Asked Questions about docs-discoverability-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit technical documentation for SEO and discoverability?▼

Run a documentation discoverability audit that maps entry points, reviews page titles, headings, URLs, and internal links, then checks sitemap, robots, canonical, and redirect configuration. Findings are prioritized as Blocker, High, Medium, or Low with a recommended change plan.

How to find orphaned or duplicate documentation pages in a repository?▼

Build a documentation map from the README, sidebar configuration, and docs directories, then flag pages missing from navigation, reachable only through deep links, or duplicating the same topic. Each duplicate set gets a recommendation to merge, redirect, label, or keep one canonical page.

Does this audit work with Docusaurus, VitePress, or MkDocs sites?▼

Yes, the audit inspects navigation and routing configuration such as docusaurus.config, sidebars files, .vitepress/config, mkdocs.yml, and astro.config. It also reviews redirects, breadcrumbs, and search configuration defined by these documentation frameworks.

Can a documentation audit confirm whether pages are indexed by search engines?▼

No, indexing cannot be confirmed from repository files alone. The audit classifies findings as Confirmed, Likely, or Unknown, and only reports indexing status when crawl reports, Search Console exports, or live deployment evidence is available.

When should I not use a documentation discoverability audit?▼

Avoid it when you only need meta titles written, prose edited for grammar, or a single sitemap generated. It is also not suited for general content marketing strategy unrelated to technical documentation.