Auto Doc Index
v1.2.0Auto-generate document index tables (ADR, RFC, Pitfall, etc.) from file frontmatter. In real-world testing, hand-maintained indexes had a 62% error rate — ti...
⭐ 0· 323·0 current·0 all-time
by@erergb
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
OpenClaw
Benign
high confidencePurpose & Capability
Name and description (auto-generate index tables from frontmatter) match the included template script and SKILL.md. The script only reads markdown files in a project doc tree and writes README.md index sections; no unrelated services, credentials, or binaries are requested.
Instruction Scope
SKILL.md instructs copying the included TypeScript template and running it to regenerate index sections between <!-- INDEX:START --> and <!-- INDEX:END --> markers. The runtime instructions and the script are consistent: they only read files under the doc/adr and doc/pitfall directories and write the README.md files in those directories. Note: the script uses regex-based parsing (no YAML lib) by design and uses a DOC_ROOT of join(__dirname, '..', 'doc'), so consumers must place the script or adjust paths appropriately. There is no instruction to read unrelated files, environment variables, or send data externally.
Install Mechanism
This is instruction-only (no install spec). The template is included as source code (TypeScript). There are no external downloads or install steps in the skill itself. Practical usage advice in README suggests running via `npx tsx`, which will pull a runtime from npm at execution time — not part of a packaged install but something users should be aware of.
Credentials
The skill declares no required environment variables or credentials and the script does not read any environment variables or config paths. The level of access requested (filesystem read of doc files and write to README.md in the targeted directories) is proportionate to the stated purpose.
Persistence & Privilege
always is false and the skill does not request permanent system presence or modify other skills or global agent settings. The default ability for the agent to invoke the skill autonomously is not problematic here and is typical for skills.
Assessment
This skill appears to do what it says: generate index tables from per-file frontmatter and inject them between explicit markers in README.md. Before using it: (1) back up your README.md (or run in a branch/CI) so you can inspect diffs the first time it runs, (2) add the required <!-- INDEX:START/END --> markers in the intended README, (3) ensure the script's DOC_ROOT matches where your docs live (the template expects ../doc relative to the script), (4) be aware the parser is regex-based — it may mis-handle unusual frontmatter formats — review generated output for correctness, and (5) running with `npx tsx` will fetch a runtime from npm at execution time, so if you prefer no network fetch, compile/transpile the script or run with an existing local Node toolchain. If you need broader guarantees (e.g., CI-only execution), integrate the generator into CI or pre-commit hooks and require reviewers to inspect the generated changes.Like a lobster shell, security has layers — review code before you run it.
adrvk975see75gpra8fsy6aabyhze582007rdocumentationvk975see75gpra8fsy6aabyhze582007rdxvk975see75gpra8fsy6aabyhze582007rlatestvk977w682fe53t000j452mqvcvh8217vmmulti-agentvk975see75gpra8fsy6aabyhze582007r
License
MIT-0
Free to use, modify, and redistribute. No attribution required.