From inkwell
Rebuilds documentation indexes from Markdown files on disk. Categorizes into Overview, Decisions, Reference, Guides; adds missing entries, removes dead links, preserves custom descriptions.
npx claudepluginhub acostanzo/quickstop --plugin inkwellThis skill is limited to using the following tools:
Rebuild the documentation index to match the actual documentation files on disk. Adds missing entries, removes dead links, and organizes by category.
Generates or updates index.md listing all files and subdirectories in a target folder with 3-10 word descriptions from file contents. Use for indexing documentation directories.
Updates a markdown file section with an index/table of files from a folder, extracting names, types, descriptions; supports lists, tables, relative links, preserves structure.
Synchronizes CLAUDE.md navigation indexes and README.md architecture docs across repositories or directories. Use for audits after code changes or triggers like 'sync docs', 'update CLAUDE.md'.
Share bugs, ideas, or general feedback.
Rebuild the documentation index to match the actual documentation files on disk. Adds missing entries, removes dead links, and organizes by category.
/inkwell:indexIf .inkwell.json exists in the project root, read the index output path from docs.index.file. Default: docs/INDEX.md.
Derive the documentation root directory from the index path (e.g., docs/INDEX.md means the docs root is docs/).
Glob all markdown files in the docs root:
<docs-root>/**/*.md — all markdown files recursivelyIf the docs root doesn't exist or contains no markdown files, report: "No documentation files found in <docs-root>/. Nothing to index."
Sort discovered files into categories based on their path:
| Path Pattern | Category |
|---|---|
<docs-root>/decisions/*.md | Decisions |
<docs-root>/reference/*.md | Reference |
<docs-root>/guides/*.md | Guides |
<docs-root>/*.md (top-level) | Overview |
| All other paths | Other |
Within each category, sort files alphabetically.
If the index file exists, read it. Parse existing entries to identify:
Generate the index file:
# Documentation Index
> Auto-generated by inkwell. Manual edits to descriptions are preserved on rebuild.
## Overview
- [ARCHITECTURE.md](ARCHITECTURE.md) — Project architecture overview
- [CHANGELOG.md](../CHANGELOG.md) — Release changelog
## Decisions
- [0001-use-postgresql.md](decisions/0001-use-postgresql.md) — Use PostgreSQL for session storage
## Reference
- [auth.md](reference/auth.md) — Authentication API reference
## Guides
- [setup.md](guides/setup.md) — Getting started guide
Rules:
Write the index file to the configured path.
Output a summary:
Rebuilt <index-path>:
Total entries: N
Added: N new entries
Removed: N dead links
Categories: Decisions (N), Reference (N), Guides (N), Overview (N)