docs: align guides and mock generation with the tree - #748
Merged
Merged
Conversation
## Summary ### Why? Guides, RFCs, and local-dev comments still described the layout from before service-scoped storage and core packages, and they still described an older orchestrator and Stovepipe pipeline. `make mocks` also skipped several packages that already had `//go:generate` directives, so `make check-mocks` could not refresh them. ### What? Repoints the architecture guide, domain READMEs, and storage docs at the live paths: shared SubmitQueue core is `changeset`, `messagequeue`, and `topickey`; request and batch helpers live under the gateway and orchestrator. Rewrites the orchestrator workflow around `pipeline.go`, including dependency analysis, a real speculate stage, the Runway land round-trip, and the hook stage. Marks shipped RFCs as implemented, and marks Stovepipe's analyze stage as designed and not built. Fixes relative links, compose build-target names, stop and status commands, and the MySQL queue RFC link. Extends `make mocks` to every `//go:generate` tree and commits the three mocks that regeneration updated. ## Test Plan - `make fmt`, `make tidy`, and `make gazelle` leave the tree clean. - License, message-id, queue-shard, and binary-file linters pass. `make lint` still reports this uncommitted diff from its format gate until the commit lands. - `make mocks` covers every `//go:generate` package, and `make test` passes 123 tests. - A local Markdown link scan finds no missing targets. Co-authored-by: Cursor <cursoragent@cursor.com>
## Summary ### Why? The documentation audit still left three claims that did not match the interfaces and cancellation behavior in code. ### What? Documents Stovepipe's actual build-runner return values, distinguishes the extension contract's historical problem from its implemented signatures, and records that cancellation leaves Landing and terminal batches for conclude. ## Test Plan - `git diff --check` - Local link validation for the three updated RFCs Co-authored-by: Cursor <cursoragent@cursor.com>
behinddwalls
marked this pull request as ready for review
September 28, 2026 17:21
mnoah1
approved these changes
Sep 28, 2026
## Summary ### Why? Autoreview found RFC sentences that still described an older pipeline: a gateway aggregate satisfying changeset.Stores, an unwired build_dlq, buildsignal republishing to itself, a missing cancelled hook, an unimplemented BuildRunner, and orchestrator topic keys named merge and land. ### What? Corrects those claims against the live controllers. Only the orchestrator aggregate satisfies changeset.Stores. build_dlq is consumed by NewDLQBuildController. Stovepipe buildsignal holds its delivery. record publishes validation.repository.cancelled. BuildRunner is the live interface. Topic keys are runway-merge and submitqueue-land, conflict checking is mergeconflictcheck.go, cancel hands only cancellable batches to speculate, and the gateway persists cancelling before publishing. ## Test Plan - `git diff --check` on the five updated RFCs Co-authored-by: Cursor <cursoragent@cursor.com>
This branch was successfully deployed
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.
Summary
Why?
Guides, RFCs, and local-development comments still described the layout from before service-scoped storage and core packages, and they documented older SubmitQueue and Stovepipe pipelines.
make mocksalso skipped packages that already had//go:generatedirectives, somake check-mockscould not refresh them. A later review pass found a few remaining sentences that still named the wrong aggregate, topic keys, and hook events.What?
Repoints the architecture guide, domain READMEs, and storage docs at the live service-scoped paths. Rewrites the orchestrator workflow from
pipeline.go, distinguishes Stovepipe's implemented pipeline from its unbuilt analyze design, and marks shipped RFCs as implemented. Corrects the reviewed build-runner, extension-input, and cancellation descriptions. Fixes broken links and local-development commands, expandsmake mocksto every generated-mock tree, and commits the three mocks regeneration updated. The follow-up states that only the orchestrator aggregate satisfieschangeset.Stores, thatbuild_dlqis consumed byNewDLQBuildController, that Stovepipebuildsignalholds its delivery, thatrecordemitsvalidation.repository.cancelled, and that the live topic keys arerunway-mergeandsubmitqueue-land.Test Plan
make fmtmake tidymake gazellemake mocksmake test— 123 tests passedgit diff --check