smithery.ai

doc-preview

Preview the documentation hierarchy and structure. Shows a tree view of docs with titles, categories, and order. Use to understand doc organization or plan new additions.

First seen Apr 11, 2026

Installation

$ npx skills add https://smithery.ai

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Skill metadata

Parsed from SKILL.md frontmatter.

Allowed toolsRead, Glob, Bash

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,465 B
  • docs SUMMARY.md 189 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

Preview Documentation Structure

Generate a visual overview of the documentation hierarchy.

Instructions

  1. Scan the documentation directories:

- If path specified, scan that directory - Otherwise scan docs/ and example/

  1. For each markdown file, extract:

- Title (from frontmatter) - Category (from frontmatter) - Order (from frontmatter) - Tags (from frontmatter)

  1. 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
  1. Include summary statistics:
## Summary
- Total documents: X
- Categories: [list of unique categories]
- Tags: [list of unique tags with counts]
- Missing frontmatter: X files
  1. 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