Preview Documentation Structure
Generate a visual overview of the documentation hierarchy.
Instructions
Scan the documentation directories:
- If path specified, scan that directory
- Otherwise scan
docs/ and example/
For each markdown file, extract:
- Title (from frontmatter)
- Category (from frontmatter)
- Order (from frontmatter)
- Tags (from frontmatter)
Generate a hierarchical tree view:
docs/
āāā [1] Getting Started (Guides) #beginner #setup
ā āāā guides/
ā āāā [1] getting-started.md - "Getting Started Guide"
ā āāā security/
ā āāā [2] authentication.md - "Authentication Guide"
āāā [2] API Reference (API)
ā āāā api/
ā āāā openapi.yaml
āāā [3] Configuration Examples (Reference)
āāā config-examples/
āāā claude-desktop.json
āāā mcp-config.yaml
- Include summary statistics:
## Summary
- Total documents: X
- Categories: [list of unique categories]
- Tags: [list of unique tags with counts]
- Missing frontmatter: X files
- Highlight issues (if any):
- Files without frontmatter
- Duplicate order numbers in same directory
- Orphan documents (no parent)
Output Format
# Documentation Structure
## docs/
### guides/ (Guides)
| Order | File | Title | Tags |
|-------|------|-------|------|
| 1 | getting-started.md | Getting Started | beginner, setup |
| 2 | configuration.md | Configuration Guide | config |
### guides/security/ (Security)
| Order | File | Title | Tags |
|-------|------|-------|------|
| 1 | authentication.md | Authentication Guide | security, auth |
## Statistics
- **Total Files**: 15
- **Categories**: Guides (8), API (4), Reference (3)
- **Most Used Tags**: security (5), api (4), beginner (3)
## Issues Found
- `docs/api/endpoints.md` - Missing frontmatter
- `docs/guides/` - Duplicate order 2: setup.md, config.md
Example Usage
/doc-preview # Preview all documentation
/doc-preview docs/guides/ # Preview guides only
/doc-preview example/ # Preview example docs