Indexion Readme
Builds project READMEs by assembling static markdown files, per-package docs extracted from code comments, and a doc.json config that controls the layout. The workflow is scaffold templates, generate API skeletons for each package (non-destructively), hand-write the prose sections, then run the assembler to produce the root README. The drift verification step is clever: it compares vocabulary deltas between versions to catch accidental deletions or rewrites, using the same sub-tokenization that powers cross-lingual checks. One gotcha is that the packages root section currently only emits a table of links, not the rich Overview/Usage expansion the schema promises, so any inline prose you see was likely hand-maintained.
- skills.sh installs
- 5.1K
- GitHub stars
- 2
- last updated
- Aug 21, 2026
Install
$ npx -y skills add trkbt10/indexion-skills --skill indexion-readme --agent claude-codeInstalls into .claude/skills of the current project.
Files
indexion readme — README Construction
Build project READMEs from templates, doc comments, hand-written prose, and
per-package READMEs. This skill covers the construction side: scaffolding,
generating, planning, assembling, and verifying. For evaluating existing
documentation, see indexion-documentation.
Where things live
The conventions vary by project; check what actually exists before editing:
| Asset | Location patterns seen |
|---|---|
| Config | doc.json (repo root) or .indexion/readme/doc.json |
| Per-package template | docs/templates/readme.md (no SoT constant; declared via --template) |
| Static prose | docs/intro.md, docs/installation.md, docs/license.md, … |
| Per-package READMEs | cmd/<name>/README.md, src/<name>/README.md |
| Assembled root README | usually README.md. Some projects use a .mbt.md suffix so the file is also a MoonBit doctest module — when so, README.md is a symlink to README.mbt.md. |
.indexion.toml | [doc] config_path / per_package auto-load doc.json |
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/trkbt10/indexion-skills
- Categories
- Documentation, Productivity & Planning
- First seen
- Jul 14, 2026
More from trkbt10/indexion-skills
All 9Recommended
More Documentation
indexion-documentationtrkbt10/indexion-skillsDocumentation analysis — assess coverage, detect code-to-doc drift with plan reconcile, visualize dependencies with doc graph. Answers "what needs docs?" and "a5Kskills.sh installs
k6-docsgrafana/skillsWrite or review k6 documentation across the three k6 repositories - k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes /4.5Kskills.sh installs
typescript-docsgiuseppe-trisciuoglio/developer-kitGenerates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API d4.4Kskills.sh installs
docs-guardamelnagdy/guard-skillsReview generated or changed documentation before it ships — READMEs, API references, docstrings, PHPDoc/JSDoc, changelogs, tutorials, and doc sites. Best used r4.1Kskills.sh installs
add-provider-doclobehub/lobehubAdd documentation for a new AI provider — usage docs, env vars, Docker config, image resources.3.9Kskills.sh installsdocs-updatergiuseppe-trisciuoglio/developer-kitProvides automated documentation updates by analyzing git changes between the current branch and the last release tag. Performs git diff analysis to identify mo3.7Kskills.sh installs