01
It starts by itself
docs or package change. Runs in GitHub Actions.
- ↻ docs or package change
pull_request paths: docs/**, cmd/**, src/**
trkbt10 · 5K installsIndexion README skill
Runs by itself, docs or package change.
README changes stay purely additive.
Install the Indexion README skill and make it a habit: follow https://gethabit.dev/skills/trkbt10/indexion-readme.md
- 1Copy
- 2Paste into Claude Code, Codex or Cursor
- 3It runs by itself
5K installs2 starsApache-2.0 licenceSource on GitHub ↗
Indexion README
by trkbt10 · 5K installs
The skill
Indexion readme builds project READMEs from templates, doc comments, static prose and per-package READMEs, then verifies edits with plan drift.
Only when you ask.
The habit
README changes stay purely additive.
↻ Runs by itselfdocs or package change
How the habit works.
You don't have to.
When does it start? How does it check its work? What does it remember?
One run, step by step.
Then it stops.
Stops after one assembly and one drift check per run.
- 01
Inspect the setup
Check for a README.md symlink, a doc.json and an .indexion.toml to see how the README is built.
- 02
Generate package READMEs
Run indexion doc readme --per-package on the package folders to create missing skeletons without overwriting.
- 03
Write the prose
Fill the Overview, Usage, Options and Examples sections of new package READMEs by hand.
- 04
Assemble the root
Run indexion doc readme --config=doc.json to build the root README.
- 05
Check drift
Snapshot the previous README with git show and compare it with indexion plan drift.
- 06
Clean up
Revert per-package READMEs that template mode created in packages you did not touch.
What it may do.
Nothing more.
It writes only in its own folder and asks you before anything goes out.
- Writes only inREADME.md, cmd/**/README.md, src/**/README.md, docs/**, loops/indexion-readme-drift-loop/**
- Talks tono outside service
- Sendsnothing
- Your OKNothing goes out, so it needs no OK.
Is it for you?
Use it when it fits.
Read both lists. If the left one sounds like you, the Indexion README skill helps.
Use it when
- ✓ You assemble a root README from parts
- ✓ You add a new command package
- ✓ You want to prove a README edit is additive
Skip it when
- – Your project does not use indexion
- – You only review existing docs quality
Indexion README skill, answered.
Will it overwrite my package READMEs?
No. Per-package generation only creates READMEs that do not exist yet.
Why does the root README show only a table of packages?
The skill notes that the packages root section currently emits a table, so rich sections stay hand-maintained.
How do I install the Indexion README skill?
Copy the prompt at the top into your agent. It installs the skill from trkbt10/indexion-skills and sets up the habit. Or run npx skills add trkbt10/indexion-skills --skill indexion-readme.
Is the Indexion README skill free?
Yes. It is published under Apache-2.0. Habit is free too.
Indexion README. Now as a habit.
Install the Indexion README skill and make it a habit: follow https://gethabit.dev/skills/trkbt10/indexion-readme.md
All trkbt10 skills →More docs skills →
Works in
- Claude Code
- Codex
- Cursor
- ChatGPT
- Claude app
Made by trkbt10, published under Apache-2.0. Habit links to the original and never changes it. Is this your skill?