agentleFS
Sign inStart free
jaskirat1616jaskirat1616/grok-skills/skills/docs-index-keeper/SKILL.md

docs-index-keeper

Skill22 starsChanged 2 months agoMITView on GitHub

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.

  • Installs packages

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill when a repository keeps docs under docs/ and needs a Markdown index table updated automatically as docs are added or changed.

    line 22
  2. Distinctive:

    keep a docs index up to date

    line 26
  3. Distinctive:

    add a pre-commit hook for docs indexing

    line 28
  4. Very specific:

    add a specific docs/*.md file into a Markdown index table

    line 30

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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/*.md file into a Markdown index table

Workflow

  1. Confirm the repo has a docs directory and an index table such as | Doc | Purpose |.
  2. Install the package if it is not already present:
npm install -D docs-index-keeper
  1. Initialize the hook:
npx docs-index-keeper init
  1. For CI enforcement, run:
npx docs-index-keeper check
  1. For one-off staged maintenance, run:
npx docs-index-keeper update

Notes

  • update operates on staged Markdown files.
  • check exits 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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free