doc-navigator

Solid

Efficiently navigate codebase documentation during Research phase. Use instead of Grep/Glob for finding architectural decisions, feature specs, and technical docs. Maps topics to doc locations for fast context retrieval. If codebase lacks documentation structure, provides patterns to establish one.

Data & Documents 26 stars 8 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
48
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Doc Navigator Navigate codebase documentation efficiently by checking known doc locations first, before resorting to grep/glob searches. ## When to Use - Finding architectural decisions (ADRs) - Locating feature specs or API docs - Researching codebase before implementation - Suggesting documentation structure for new projects - Alternative to grep/glob for doc discovery ## Quick Start 1. Check for docs directory at project root 2. Scan for common doc file patterns 3. If docs exist → map topics to locations 4. If no docs → suggest documentation structure (see `references/doc-patterns.md`) ## Common Documentation Locations Check these locations in order: ``` project-root/ ├── docs/ # Primary documentation │ ├── architecture/ # System design, ADRs │ ├── features/ # Feature specs │ ├── api/ # API documentation │ └── guides/ # How-to guides ├── .github/ # GitHub-specific docs │ └── docs/ ├── README.md # Project overview ├── ARCHITECTURE.md # High-level architecture ├── CONTRIBUTING.md # Contribution guidelines └── doc/ or documentation/ # Alternative doc folders ``` ## Topic-to-Location Mapping | Looking for... | Check first | |----------------|-------------| | Project overview | `README.md` | | Architecture/design | `docs/architecture/`, `ARCHITECTURE.md`, `docs/adr/` | | Feature specs | `docs/featu...

Details

Author
georgekhananaev
Repository
georgekhananaev/claude-skills-vault
Created
6 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category