docs(sync): harmonize documentation and READMEs across the repo - #131
Draft
Soushi888 wants to merge 1 commit into
Draft
docs(sync): harmonize documentation and READMEs across the repo#131Soushi888 wants to merge 1 commit into
Soushi888 wants to merge 1 commit into
Conversation
Resolved 12 cross-document conflicts. Deferred 2 items for human decision. First documentation sync anchor.
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.
Intent
The docs had drifted apart from each other and from the code. A reader landing on
CLAUDE.mdwas told this is a "3-zome Holochain hApp" whileREADME.mdcorrectly described a five-role multi-DNA hApp.TEST_COMMANDS.mdsaid Tryorama was "still the primary test suite" while every other doc said it was deprecated. Five files pinned Vite 6.2.5 whenui/package.jsonhas been on Vite 7. Eleven files referenced anEncryptedProfileentry type that does not exist anywhere in the codebase.This is a full documentation sync pass: every doc-to-doc contradiction found, arbitrated against code evidence, and resolved with one canonical home per claim. Ran via
/CodeDocs Syncover 96 markdown files.Changes
Contradictions resolved against code (7). Each was checked against the source, not against whichever doc looked newest.
Vite 6.2.5in 5 filesui/package.json:45→^7.0.40.19.0in 5 files^0.20.0(UI),^0.19.1(root tooling)ui/package.json:51, rootpackage.jsonworkdir/happ.yaml:5-60— lobby, nondominium, hrea, group, ndoTEST_COMMANDS.md: Tryorama "still the primary test suite".rules,tests/DEPRECATED.md, IMPLEMENTATION_STATUSEncryptedProfile(11 files)PrivatePersonDatazome_person/src/lib.rs:59— noEncryptedProfiletype exists[[test]]binaries"tests/Cargo.tomlmanifestsdocumentation/archives/{agent,resources,governance}.mddocumentation/requirements/archives/Superseded content refreshed.
.rulesdevelopment status was three months behindREADME.mdand now points at it.tests/DEPRECATED.mdclaimed the resource and governance migrations were "Not started" when both Sweettest modules exist (137 and 307 lines); the table now reflects reality and lists the Sweettest coverage that has no Tryorama predecessor.tests/README.mdhad no deprecation banner at all despite sitting besideDEPRECATED.md; it has one now.Duplication collapsed to canonical homes. The tech-stack block was repeated verbatim in five files, each carrying the same two stale versions. It now lives once in
README.md § Technology Stack; the others link. Same for the Sweettest command block (five copies) which now lives indocumentation/TEST_COMMANDS.md.Structure.
ui/README.mdwas still the untouched SvelteKit scaffold: titled# sv, instructingnpx sv createandnpm run dev. Replaced with a real README covering the multi-agent dev harness, per-agent origin isolation viaVITE_DEV_AGENT, checks, E2E, and thelib/layout.README.mdsetup was missinggit submodule update --init --recursive, which is genuinely required —build:happrunscd vendor/hrea && cargo buildand packsvendor/hrea/dnas/hrea/workdir, so the build fails without it.README.mdstill listed "NPM Workspaces" and Tryorama as current stack, contradicting the bun-only convention stated 200 lines above it.documentation/README.mdis the hub,DOCUMENTATION_INDEX.mdthe annotated guide,SUMMARY.mdthe flat TOC, and the root README a short pointer. Each links to the others; previously the hub linked to neither of the other two.ui/tests/README.mdbut linked from nowhere. Now reachable from README, the hub, TEST_COMMANDS, and.rules.pai/cursor-rules/20-architecture.mdgained a Multi-DNA Topology section; it is always-loaded agent context and described only the three zomes.Links: 34 broken → 0. All were path moves after files were relocated (
archives/{agent,resources,governance}.md→requirements/,post-mvp/lobby-dna.md→requirements/lobby-dna.md,versioning.md→ndo-versioning.md, and the lobby-architecture and valueflows-dsl pairs). Two dead anchors fixed against their real headings. One link pointed atuser-story-resource-transaction.md, which exists nowhere; retargeted touser-story-ERP-bridge.md, the actual home of the Sarah/Sensorica and Marco/FabLab participants that sentence describes.Decisions
CLAUDE.md/AGENTS.md/GEMINI.mddirectly.rules. Edits go to.rules, which is tracked and is itself the source (only.cursor/rulesis nix-materialized frompai/).TEST_COMMANDS.mdPropertyRegime6-vs-4 splitP2PMODELS_COMPARISON_REPORT.mdversionsHow to test
Expect
broken: 1. The single remaining hit is a false positive:ndo_prima_materia.md:19targets#6-the-surface-of-attachment--capability-slots, and the heading contains an em-dash. GitHub strips the em-dash and leaves both surrounding spaces, producing two hyphens; the checker collapses them to one. The link resolves correctly on GitHub.Spot-check the code-arbitrated claims:
No code changed, so no build or test run is required.
Documentation
This PR is documentation only. 24 files:
README.md,.rules,REVIEW.md,ui/README.md,tests/README.md,tests/DEPRECATED.md, 3 files underpai/, and 15 underdocumentation/.Related
Related issues:
Still open, deliberately out of scope:
PropertyRegimehas 6 variants in Rust and 4 in TypeScript.crates/shared/src/types.rs:47carries Private, Commons, Collective, Pool, CommonPool, Nondominium;packages/shared-types/src/resource.types.ts:176carries four, with Collective and Pool documented as "removed after design review". The docs describe both sides accurately andresources.md §2.6already asks for a reconciliation pass. Fixing it means either dropping two Rust variants (a breaking change toNondominiumIdentityvalidation) or restoring them in the UI. That is a code decision and wants its own issue.documentation/requirements/post-mvp/complete-resource-specification.mdis 0 bytes. Dropped from theSUMMARY.mdTOC rather than linking an empty page. The file is left in place pending a decision to write it or delete it.Closes #135