Skip to content

Documentation state audit — dashecorp rig (2026-04-18)

Docs state audit — dashecorp rig (2026-04-18)

Section titled “Docs state audit — dashecorp rig (2026-04-18)”

~57 markdown docs across 7 active repos. ~70% frontmatter compliance by file count, ~55% when weighted by repo. Worst offender: rig-agent-runtime/docs/ at 33% (8 of 12 docs have only title:). Only rig-memory-mcp has a CLAUDE.md; 5 repos have AGENTS.md; rig-tools has neither (the outlier). Three architecture docs live side-by-side with no supersedes: chain. The CI check enforces 4 of the 5 frontmatter fields (skips queries) — confirming queries is dead weight. docs-site/ is generated by scripts/build-docs.sh, not duplicated.

RepoCLAUDE.mdAGENTS.mddocs/.md countFrontmatter complianceNotes
conductor-e6 + diagrams/833%api.md, index.md missing type/queries/updated
rig-agent-runtime12 + images/1433%Worst; 8/12 docs have only title:
rig-gitops7 + whitepaper/193196%Exemplar
review-e130%Single doc, zero frontmatter
rig-tools120%Only repo with NEITHER agent file. Stub starts mid-document.
rig-memory-mcp14100%Only repo with CLAUDE.md
infra(none)4N/ANo docs/ dir; root files only
  1. Three architecture docs side by side. rig-gitops/docs/architecture-current.md (10 KB), architecture-proposed.md (9 KB), architecture-proposed-v2.md (24 KB). All updated: 2026-04-16. None links to the others as superseded. Worse: scripts/build-docs.sh:24-26 only copies -current and -proposed to the published site — proposed-v2.md is invisible to readers of rig-docs.pages.dev.

  2. rig-agent-runtime/docs/ frontmatter collapse. 8 of 12 files carry only title:. The 16 KB configuration.md has only title + updated.

  3. rig-tools/docs/agent-workflow.md starts at ## Workflow (no H1, no frontmatter) and references the old Stig-Johnny/rig-tools namespace — contradicts the rig’s “no personal namespace deps” posture.

  4. Empty stub directories. rig-gitops/docs/cost-dashboard/ contains only data.json + index.html (no .md). docs-site/docs/components/dev-e/ still published despite dev-e archived 2026-04-17.

  5. CI checks 4 of 5 frontmatter fields. .github/workflows/docs-check.yml validates title description type updated but skips queries. The standard requires all 5; the CI is a subset of the standard it cites.

Findings that contradicted prior assumptions

Section titled “Findings that contradicted prior assumptions”
  • docs-site/ is not a duplicate — it is generated by scripts/build-docs.sh. Deleting docs-site/ loses nothing because the script reconstructs it. (Running manually; no CI step.)
  • AGENTS.md is dominant (5 repos) vs CLAUDE.md (1 repo). The “CLAUDE.md everywhere” recommendation should be inverted.
  • Three repos run mkdocs.yml (conductor-e, rig-agent-runtime, rig-gitops) — each can publish its own site independently, in addition to the aggregated rig-docs.pages.dev. Three publication surfaces, not one.

Audit ran via gh api against GitHub’s contents + trees APIs on 2026-04-18. No local checkout; no destructive action. Results are a point-in-time snapshot; state changes with every PR merge.