doc-gardener
Objective
Keep docs minimal, accurate, and mechanically checkable.
Workflow
- •Identify changed docs scope (
docs/index.md,docs/agentic/index.md, related pages). - •Update links and indexes so every referenced local path resolves.
- •Keep edits minimal and factual; remove stale references when deleting docs.
- •Run
npm run docs:check. - •Run
npm run fmt. - •Run
npm run checkwhen docs changes affect governance or verification scripts.
Standards
- •Keep one canonical entrypoint per audience:
- •User docs:
docs/index.md - •Agent docs:
docs/agentic/AGENT-START.mdanddocs/agentic/index.md
- •User docs:
- •Prefer relative local links for repository docs.
- •Avoid unresolved placeholder markers unless tracked intentionally.
- •If work is deferred, log it in the repository issue tracker.
Guardrails
- •Do not change product behavior through docs-only work.
- •Do not add large new doc systems unless requested.
- •Preserve existing repository conventions and wording style.
Output Contract
- •Report files changed, links fixed/removed, and verification commands run.
- •Explicitly call out any deferred docs follow-up entries added.