Repository navigation
📝 Make the architecture documents easier to read and navigate - #913
Merged
taras merged 1 commit intoOct 14, 2026
Merged
Conversation
taras
marked this pull request as ready for review
October 14, 2026 15:54
This was referenced Oct 14, 2026
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.
Why
Readers had to learn terminology and a large construct inventory before seeing how a document runs. Detailed rules were repeated across architecture and feature specifications, with several descriptions lagging behind shipped behavior.
Closes #911. Stacked on #910; this diff starts at its reviewed head,
1ef21a6f8fe659f25ea214eaecc5fff4af1c4b87.What changes
Before: readers searched long documents and reconciled repeated explanations themselves.
After: README offers six question routes. Architecture starts with a write/read/delete execution and replay example, then follows ownership, execution, failures, workflow state, files, agents and extension boundaries. Terminology and the construct inventory serve as linked references after those concepts. Feature specifications retain their interfaces and conformance evidence while linking to the detailed architecture rules. The decision log distinguishes historical sequencing from current behavior.
The rewrite also corrects source-verified stale descriptions of workflow definitions, artifacts, protected components, generated evaluation, native session routes and diagnostic journals.
Review guide
Start with README's architecture links and
architecture.md#reading-this-architecture. Follow the write/read/delete example, then inspect the relevant boundary rather than reading the moved diff linearly.Review the shortened terminology and inventory alongside their linked owners. Check the Plan, workflow and native-session specifications for the preserved profile and compatibility exceptions.
specs/decisions.mdrecords Plan delivery history and the partial supersession of earlier durable-expansion decisions.Look carefully at the separate settlement contracts: component invocation aggregates body and teardown failures; whole-document execution ranks its final Result; Plan retry requires successful cleanup.
What must stay true
How to verify it
Focused checks:
git diff --checkandnode scripts/lint-architecture.jspass.The scratch preservation audit accounts for all 7,486 baseline units across the 25-document corpus. Independent checks verify 7,113 exact retained units, 36 exact moved units, one unchanged-word reflow and 336 semantic transfers/corrections; every normalized canonical destination resolves. Existing anchors and conformance row identifiers survive. All 470 code fences are accounted for, with only the four enumerated stale-document exceptions.
Six advertised navigation tasks pass through actual links and explicitly recorded heading-outline browsing. The first walkthrough's route failure is retained separately from the repaired run. Four overlays run through the same verifier and reject a missing constraint, broken anchor, changed diagnostic fence and removed conformance ID.
Independent Planner (A1–A10) and Architect (six structural criteria) reviews pass on
e3afc34f49bb3dfbf508bc4ae5091c941f35be40. The independent exact-commit audit reports zero failures. Deliverydeno task lintexits 0; it emits warnings from unchanged source files. The committed branch diff also passesgit diff --check.Scope
Documentation and navigation only. The full 25-document survey corpus was assessed; files without a relevant correction or navigation improvement remain unchanged. No runtime, dependency, lockfile, generated output or executable-asset changes.
Risks and limitations
The substantive risk is losing a qualification while consolidating prose. A clause-transfer record and independent structural review check the destinations; exact comparisons protect unchanged material, fences, identifiers and the parent corrections. Six navigation exercises check the advertised routes. These are agent walkthroughs, not measurements of human comprehension or reading time.
Scope confirmation