back
loading skill details...
README construction — initialize template structure, generate per-package READMEs from doc comments, plan writing tasks, assemble root README from docs/ and…
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
don't have the plugin yet? install it then click "run inline in claude" again.