Skip to content

docs: the older stage contract retired; finalize's page retired, stage and selftest gone from the tool page (mig-contracts) - #128

Merged
rusholme merged 1 commit into
mainfrom
mig-contracts/1-docs
Oct 25, 2026
Merged

rusholme merged 1 commit into
mainfrom
mig-contracts/1-docs

Conversation

@rusholme

Copy link
Copy Markdown
Collaborator

The older stage contract is retired from the system pages, matching rapid PR 464: run(job) is the one contract (mig-contracts task 1).

What and why

  • finalize.md gets the retired banner and stays in the hidden "Retired" toctree with the run model's pages, the same treatment mig-stale gave them (PR 120). Its body is kept as the record of the port.
  • index.md: the section is now "Retired pages", and the stage-contract row no longer lists the older contract.
  • stage-contract.md: the rapidpipe.selftest row and revision leave the package table and the layer order, the test doubles are named under tests/support/, "Stages on the older contract" becomes "The older contract, retired", and "Not decided here" replaces the port of admit and finalize with the post-processing question.
  • tool.md: the stage and selftest rows are gone, and the exit-code line points to what job run returns.
  • migration.md: the post-processing row says retired with rapid PR 464; the logging row no longer claims log/<stage>.log, which only the retired runner wrote. Question 11 (post-processing) is left as the team's.
  • decisions.md: one line. The older contract is retired and git keeps it; whether a post-processing stage returns stays migration question 11.

Files

system/decisions.md, finalize.md, index.md, migration.md, stage-contract.md, tool.md.

Divergences from the brief

  • There is no admit page and no selftest page, so only finalize.md gets the banner. stage-contract.md mostly describes the live run(job) contract, so only its older-contract section is retired. The page itself stays current.
  • migration.md has no rows of its own for stage and selftest; those were in the migration ledger, not on the page. The two rows that described the older contract are corrected.
  • No current page said a failed loop exits 2 or named RAPIDPIPE_BATCH_JOB_DEFINITION (git grep over system/), so nothing needed correcting for either.

Measurements

None. These are docs edits; the build runs in CI (no local venv on this host).

Improvements seen

observability.md still describes the run model's per-stage log file, exec/<attempt>.json, --profile on run submit, and run timings. Its banner already says the foundation page governs where they differ. A rewrite to the job contract is a page of its own, so it is seen and not done here.

Session notes

none

What the next task must know

finalize is retired; the post-processing question is the team's (migration question 11).

🤖 Generated with Claude Code

…e and selftest gone from the tool page, one decisions line (mig-contracts)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@rusholme
rusholme merged commit 9b00d2b into main Oct 25, 2026
2 checks passed
@rusholme
rusholme deleted the mig-contracts/1-docs branch October 26, 2026 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant