[harness] Add the RCAC-Docs documentation factory (spec-driven authoring lifecycle) - #273
Merged
Conversation
TECH.md YAML-FSM helpers (_fsm/next_phase/set_phase) ported from the HyperShell factory and adapted to python3; strict_check.py gates 'mkdocs build --strict' against strict-baseline.txt (7 known pre-existing warnings) so only regressions block.
methodology (the why), invariants (curated footgun subset of AGENTS.md), EARS acceptance-criteria syntax, the archetype/style guide, and the reviewer rubric (CONFIRMED vs PLAUSIBLE).
Doc-native skeletons; TECH.md defaults base:main with 'mkdocs --strict' verify seeds and docs phase archetypes.
docs-feature -> docs-plan -> docs-draft -> docs-review -> docs-publish; publish targets main, blind adversarial review, venv/env-assert pre-flight.
Purdue-branded getting-started.html (AA-safe, dark+light); least-privilege .agents/settings.json allowlist; spec/README.md describing per-job design records.
Restructure into operating manual + load-bearing invariants + a 'working as an agent' factory section; drop the Co-Authored-By convention; correct stale Read-the-Docs/S3 references. CLAUDE.md symlinks AGENTS.md.
.claude -> .agents so Claude Code discovers the skills; un-ignore .claude and ignore only .agents/settings.local.json.
Add spec/**, .agents/**, AGENTS.md, CLAUDE.md to deploy_to_geddes_prod paths-ignore -- they never affect the built site.
Guangzhen-Jin
approved these changes
Jul 15, 2026
Member
Author
|
Broken links and |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adapts the HyperShell spec-driven "software factory" to this documentation site, so agents can
shape → plan → author → review → ship documentation and training material with traceability and
human-gated review. Tooling only — no changes to published content. Everything lives outside
docs/, so nothing is added to the built site.What's here
.agents/skills/docs-*):/docs-feature→/docs-plan→/docs-draft→/docs-review→/docs-publish(buildrenameddraftto avoid colliding withmkdocs build)..agents/factory/):methodology.md,invariants.md,ears.md,style-guide.md,review-rubric.md, thegetting-started.htmlonboarding page,templates/, andthe FSM/
strict_checkscripts underbin/.AGENTS.mdrewritten as an operating manual + load-bearing invariants + a"working as an agent" section (
CLAUDE.mdsymlinks it)..claude → .agentssymlink (now git-tracked), narrowed.gitignore, and aleast-privilege
.agents/settings.jsonallowlist.deploy_to_geddes_prodskips factory-only bookkeeping paths.Key design decisions
verify:runsmkdocs build --strictpiped throughstrict_check.py, gating only on warnings not already in a captured baseline. (Prod CI buildswith
--verbose, so broken links / nav orphans ship silently today — the factory closes that gap.)main— a merge auto-deploys to Geddes within ~5 min, so there is no staginggate and review is the last line of defense.
dev(the a11y branch) is off-limits.hammerable: falsefor HPC technical accuracy, WCAG 2.1 content accessibility, and buildintegrity — the reviewer may never scope-cut them.
(HPC accuracy / prose a11y → human triage).
Co-Authored-Bytrailer on commits (clean-log convention; §12 of AGENTS.md).Running
mkdocs build --strictrevealed 7 real broken internal links already onmain(wrong../depth, a missingindex.md, a doubleduserguides/userguides/…path). They're recorded in.agents/factory/strict-baseline.txtso the gate keys on regressions only. Not fixed here (2 arein tool-generated catalog files) — an ideal first
fix/job for the factory to dogfood.Verification
next_phase/set_phaseround-trip (dependency gating, canonical fieldorder, body preserved verbatim).
.agents/andspec/are absent fromsite/..claudesymlink + factory are tracked while__pycache__and
settings.local.jsonare ignored.Try it
After merge (or checking out this branch) and reloading Claude Code so it discovers
.claude/skills/,start a job with
/docs-feature. The full walkthrough is.agents/factory/getting-started.html(open it in a browser) or
.agents/factory/methodology.md.Note
This is a substantial methodology addition intended to sit for human review before we test-drive it
across a few real use-cases and refine.
🤖 Generated with Claude Code