indexion README construction: template, assemble and verify project READMEs
Init templates, generate per-package READMEs from doc comments, assemble root README via doc.json, verify edits with plan drift
- What
- Init templates, generate per-package READMEs from doc comments, assemble root README via doc.json, verify edits with plan drift
- Cost
- Free
- Needs
- the indexion CLI installed (the skill drives it — without it, the workflow is manual); a project with packages/docs to document
- Install
- Copy the installer prompt below into your Muse — your agent does the rest.
Curated by Skill Harbor — @trkbt10's indexion-readme: the construction side of README automation for the indexion CLI — initialize template structure and doc.json, generate non-overwriting per-package READMEs from doc comments, assemble the root README from static prose and package entries via doc.json config (or placeholder templates), and verify that edits are purely additive with `plan drift` (cosine-distance guard usable in CI). Documents the asset conventions (config at root or .indexion/readme/, per-package templates, README.mbt.md symlinks), the template syntax, .indexion.toml integration, and known pitfalls — including a candid "known limitation" section where the packages root section currently emits a table instead of rich expansion. Apache-2.0 licensed. Honest notes: the indexion CLI must be installed first — without it the skill is a manual checklist; and template mode auto-creates READMEs in every package it walks, so run it on narrow paths or check git status after. Skill Harbor never reviews the code, review it yourself before use. Discovered via skills.sh.
Version:
Install
Prerequisites: the indexion CLI installed (the skill drives it — without it, the workflow is manual); a project with packages/docs to document Install "indexion README construction: template, assemble and verify project READMEs" for me. It gives my agent @trkbt10's construction-side README skill for the indexion CLI: initialize template structure and doc.json, generate non-overwriting per-package READMEs from doc comments, assemble the root README via doc.json config or placeholder templates, and verify edits are purely additive with plan drift (CI-usable cosine guard) — with conventions, template syntax and known pitfalls documented. Apache-2.0 licensed. Repository: https://github.com/trkbt10/indexion-skills/blob/main/skills/indexion-readme/SKILL.md 1. Fetch the SKILL.md file (and any helper files) from the repository path into a temporary folder and summarize what it does in one or two sentences. 2. Safety check: review the SKILL.md and scripts for anything suspicious (unexpected network calls, shell commands, credential harvesting). This repo should contain zero secrets in code, credentials only via the secure vault, allowed hosts declared in the SKILL.md. Verify that holds here; STOP on any red flag and tell me. 3. Install it as a skill: copy SKILL.md and its helper files into the agent's skills directory, in a folder named "indexion-readme". 4. Verify with no network calls: frontmatter valid, files in place. 5. Report what was installed, where, and what I still need to do myself (e.g. install the indexion CLI, then point the agent at the project to document). GitHub is optional: if I have a GitHub account or the gh CLI, you may use it; otherwise public access is fine. Never require it unless it's in the prerequisites above. Rules: don't touch anything outside the temp folder and the install target. If anything looks off, stop and ask me.
Questions
How do I install a build?
Every product page includes a copy-paste install prompt. Paste it into your Muse and it sets the build up for you — no manual configuration.
Where does my money go?
Straight to the seller. Skill Harbor never processes payments: checkout happens on the seller’s own page, usually Stripe.
What does the ✓ next to a creator’s name mean?
It means we confirmed the identity of the person behind the listing. It says nothing about the code itself — always check a build before installing it.