docs(#519): renumber live v2.0.0/v2 Go-port references to v1.0.0 (post-ADR-0009) #603
No reviewers
Labels
No labels
bump
major
bump
minor
bump
patch
kind/bug
kind/chore
kind/docs
kind/feature
priority/critical
priority/high
priority/low
priority/medium
size/L
size/M
size/S
size/XL
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
frankenbit/release-toolkit!603
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "chore/renumber-v2-refs-to-v1"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Closes #519.
Renumbers live references to v2.0.0 / v2 Go-substrate across 13 architecture docs to v1.0.0 (post-ADR-0009 single-stack direction). Deliberately preserves historical + future-major refs (see discrimination table below).
Sweep scope
Tier 1 mechanical renumbering (26 changes across 13 files after Surveyor 4670 review-round-2):
docs/architecture/arc42/README.mddocs/architecture/test-strategy.mddocs/architecture/contracts/README.mddocs/architecture/contracts/workflow-api.mddocs/architecture/contracts/config.schema.jsondocs/architecture/arc42/04-solution-strategy.mddocs/architecture/arc42/05-building-block-view.mddocs/architecture/arc42/06-runtime-view.mddocs/architecture/arc42/07-deployment-view.mddocs/architecture/arc42/09-architecture-decisions.mddocs/architecture/arc42/11-risks-technical-debt.mddocs/architecture/c4/README.mddocs/architecture/c4/release-toolkit.likec4Deliberately preserved (verified by Surveyor 4670)
docs/adr/0008-go-port-architecture.md(entire file)contracts/README.md:62,contracts/workflow-api.md:97(v2.0.0 may add optional fields)v2/nextbranch as historical arc markerarc42/04-solution-strategy.md:49Tier 2 deferred → #609
Surveyor 4670 identified
docs/architecture/branch-strategy.md(30 v2/v2.0.0 refs, entirely untouched here) as modeling the OLD parallel-lane branch scheme (shell =v1.x/main; Go port =v2.x/v2next; cutover). Post-ADR-0009 this model is gone — single-stack, Go port lands as v1.0.0 in main.Beyond mechanical renumbering: the arc42/README + c4/README + test-strategy.md status headers still read as "proposed (analysis-only)" and "Branch:
v2/next" — accurate at authoring time, stale post-ADR-0009.Filed as #609 (docs: branch-strategy.md + arc42/c4 status headers model-rework post-ADR-0009). Non-gating for v1.0.0.
Verification
git diff origin/main --name-only= 14 files touched (13 arch docs + 0 code)v1.0.0 Go port,v1.0.0 cut, etc.Anchor
b8df0d3) + Tier 2 filed as #609 + disclosed aboveReview — v2→v1 Go-port renumber (#603, #519) — COMMENT (incomplete sweep)
The 22 renumbered refs are accurate, and the discrimination is good — notably
workflow-api.md:94/97correctly keptv2.0.0(that's the future major after v1.0.0: "v2.0.0 may add optional inputs… without a major-version adopter-migration note" — SemVer, not the Go port), andv2/next(branch name) + retro "Protocol v2/v2.1" + VERSIONING.md future-major were correctly left. But the sweep is incomplete in a way that leaves the docs internally inconsistent, so I'm commenting rather than approving.Tier 1 — same-file misses (live Go-port
v2.0.0refs left in files the PR renumbered)These are the same class the PR changed elsewhere, sitting in files it touched:
arc42/README.md:11— "the v2.0.0 Go-port analysis (ADR-0008)" — its siblings on lines 15 ("v2 Go port" → v1.0.0) and 95 ("v2 Go port's block structure" → v1.0.0) were changed. Line 11 is the same referent, missed.test-strategy.md:270— "That is the v2.0.0 end-state." (the Go-port end-state)test-strategy.md:272— "Dropping a seam's env-var reader before v2.0.0" — this is 3 lines above line 275, which the PR did change ("retired at the v2.0.0 cut" → "v1.0.0 cut"). Same paragraph, same referent, one changed one not.test-strategy.md:368— "When v2.0.0 approachesmain, the differential harness becomes a CI job" (the Go-port approaching main)Result: files that now say "the v1.0.0 Go port" in one line and "the v2.0.0 end-state" in another — more confusing than the uniform-stale starting point. These read as an incomplete find-replace, not a scope decision.
Tier 2 —
branch-strategy.mdcontradicts the renumber (scope question)branch-strategy.mdisn't in the PR's file set at all, but it is the authoritative branch/version-model doc, and its entire model is the old framing:main" vs "v2.x — Go substrate →v2/next→v2.0.0-alpha.N…v2.0.0→@v2.0.0"v2/nextbecomesmain"; line 53: "requiresv2/nextto cut v2.0.0-alpha.N"; lines 149/180/182: adopters pin@v2.0.0Post-#603, the arc42/contracts set says "the v1.0.0 Go port" while branch-strategy.md says "the Go substrate is v2.x on
v2/next, cut as v2.0.0." Those are mutually contradictory. This is a bigger change than a renumber (it's the v1.x-shell / v2.x-Go / cutover model), so it may be deliberately out of #519's scope — but if so, the contradiction should be disclosed (a one-line note that branch-strategy.md's version model is pending a separate rework and intentionally diverges), because right now a reader hitting both docs gets two incompatible answers to "what version is the Go port?"Recommendation
Non-gating for v1.0.0 (docs), and the completed 22 are correct — but as it stands the PR half-meets its "renumber live Go-port refs" goal and introduces same-file inconsistency. Happy to re-review + stamp once the sweep is completed or the scope is explicit. — Surveyor
Re-review — #603 @
b8df0d3(Tier 1 fold + Tier 2 disclosure) — APPROVEDBoth review-4670 findings resolved; verified independently.
Tier 1 — complete (5/5, verified at source):
arc42/README:11,test-strategy:270/272/368all now readv1.0.0, plus your bonus catchtest-strategy:386("after v2.0.0" → v1.0.0) — same class, same file, would have surfaced next round. Good catch.Absence claim re-verified (not trusted): I re-scanned the resulting state of all 13 touched files, unfiltered, for
v2.0.0/v2 Go/v2.x. The only two remaining arecontracts/README.md:62andworkflow-api.md:97— both genuinely future-major ("v2.0.0 may add optional fields… without a major-version migration note"), i.e. what a future major is allowed to do to the frozen v1.0.0 contract. Correctly kept, not Go-port refs. No live Go-portv2.0.0misses remain in scope. The same-file inconsistency 4670 pinned is closed.Tier 2 — deferred + disclosed, as recommended:
#609is filed and open ("branch-strategy.md + arc42/c4 status headers model-rework post-ADR-0009"), the PR body carries the explicit "Tier 2 deferred → #609" section, and the discrimination table rows the deferred class. That closes my disclosure ask — a reader hitting branch-strategy.md's still-v2.x model now has the pointer to the rework that reconciles it. The model-rework being its own session (substantive rewrite, not renumber) is the right call.Verdict
APPROVED, head-pinned at
b8df0d3. The in-scope renumber is now complete and internally consistent (independently re-scanned), the two kept refs are correctly future-major, and the Tier 2 model-rework is honestly deferred + tracked at #609 with in-PR disclosure. (Base has moved to #608's merge; #603 touches no ADR-0008, so no conflict — clean.) Yours to land.— Surveyor