docs: close-out — honest quickstart, sketch guides/ADRs, wiki seed, planned scaffolding - #29
Merged
Merged
Conversation
…ed, planned scaffolding Documentation close-out pass. No functional/code changes. - QUICKSTART-USER.adoc: replace the generic RSR CLI-app boilerplate (just setup/run/doctor/heal/tour/uninstall — none of which exist for a Worker/registry) with an honest registry/API quickstart, marked alpha. - Index the 1-line "Unit" stub READMEs that sit atop real content: docs/practice, docs/developer, docs/governance, docs/decisions, docs/README. - Add sketch guides (honest "planned" outlines): developer/VERISIM-QUERY-GUIDE, developer/REPO-ONBOARDING, USER-API-GUIDE, governance/INCIDENT-RESPONSE. - Add 5 ADR sketches: 0001 pointer authority, 0002 clade taxonomy, 0003 VeriSimDB+KV (accepted/retro-documented), 0004 API versioning, 0005 governance exceptions (open). - Seed docs/wikis/ (Core-Concepts, Workflows, Glossary) + index; sync automation tracked separately. - Mark 29 empty RSR scaffold READMEs (theory/, whitepapers/, reports/, governance planning|audit|maintenance substubs, standards) as "planned — not yet written" so they stop implying false completeness (guarded: real content untouched). - STATE.a2ml: bump last-updated; register sketches + recent CI/docs changes. Follow-up issues: Worker API contract (OpenAPI), release runbook (Phases 3-8), wiki sync automation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UCnxjXkN6uDj9YSANuGEgR
hyperpolymath
marked this pull request as ready for review
June 21, 2026 22:55
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
2 participants
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.
What
Documentation close-out pass — no code changes (49 files, +703/−128). Driven by an audience-segmented docs audit (developers / maintainers / end-users).
Honesty fixes
QUICKSTART-USER.adocrewritten — it was the generic RSR CLI-app template (just setup/run/doctor/heal/tour/uninstall, "install location choices") describing software that doesn't exist for a Worker/registry. Now an honest registry/API quickstart, marked alpha.= X Unitstubs sitting atop real content now index it:docs/practice,docs/developer,docs/governance,docs/decisions,docs/README.theory/,whitepapers/,reports/, governanceplanning|audit|maintenancesubstubs,standards/) marked "planned — not yet written" so they stop implying false completeness. (Guarded by a line-count check — a 17-line real doc was correctly skipped.)New sketch areas (honest "planned" outlines)
docs/developer/VERISIM-QUERY-GUIDE.adoc,docs/developer/REPO-ONBOARDING.adocdocs/USER-API-GUIDE.adoc(the biggest end-user gap)docs/governance/INCIDENT-RESPONSE.adoc0001–0005: pointer authority, clade taxonomy, VeriSimDB+KV (accepted/retro-documented), API versioning + governance exceptions (open)Wiki ("sketch + plan sync")
docs/wikis/— Core-Concepts, Workflows, Glossary + index. Sync automation tracked separately.Machine-readable
STATE.a2ml: bumpedlast-updated; registered the sketches + recent CI/docs changes under[documentation.sketches]/[recent-changes].Follow-up issues
🤖 Generated with Claude Code
https://claude.ai/code/session_01UCnxjXkN6uDj9YSANuGEgR
Generated by Claude Code