Docs index keeper
Keep a repository's Markdown docs index in sync by installing and running docs-index-keeper in pre-commit hooks, CI, or one-off maintenance flows.From its SKILL.md
npx -y skills add oleg-koval/agent-skills --skill docs-index-keeperAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its file declares
Copied from the file, not written here
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
1.7 KB, 274 tokens by cl100k_base, as published. Nobody here has run it
docs-index-keeper
Use this skill when a repository keeps docs under docs/ and needs a Markdown index table updated automatically as docs are added or changed.
Trigger phrases
- keep a docs index up to date
- auto-update
docs/README.md - add a pre-commit hook for docs indexing
- enforce docs index freshness in CI
- add a specific
docs/*.mdfile into a Markdown index table
Workflow
- Confirm the repo has a docs directory and an index table such as
| Doc | Purpose |. - Install the package if it is not already present:
npm install -D docs-index-keeper
- Initialize the hook:
npx docs-index-keeper init
- For CI enforcement, run:
npx docs-index-keeper check
- For one-off staged maintenance, run:
npx docs-index-keeper update
Notes
updateoperates on staged Markdown files.checkexits non-zero when the index is missing entries for staged docs.- Purpose text comes from the first Markdown heading when available.
- New rows are inserted before an archive sentinel row when present.
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.