# Docs Index Keeper

> Keep a repository's Markdown docs index in sync with the files that actually exist, by installing and running docs-index-keeper in a pre-commit hook, in CI, or as a one-off sweep. Use when the user says "the docs index is stale", "update the docs index", "add a docs index check to CI", "our doc links are out of date", or when new docs were added without being linked anywhere.

- Skill: `oleg-koval/docs-index-keeper-2` (Agent Skill)
- Install (CLI): `npx skillmds@latest add oleg-koval/docs-index-keeper-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/oleg-koval/docs-index-keeper-2/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- License: MIT
- Author: oleg-koval (https://skillmd.com/u/oleg-koval)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/oleg-koval/docs-index-keeper-2

---

<!-- Generated by scripts/build-adapters.sh. Do not edit directly. -->

# 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:

```bash
npm install -D docs-index-keeper
```

3. Initialize the hook:

```bash
npx docs-index-keeper init
```

4. For CI enforcement, run:

```bash
npx docs-index-keeper check
```

5. For one-off staged maintenance, run:

```bash
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.