docs: align READMEs and RFCs with current code and AGENTS.md conventions - #629
Merged
mnoah1 merged 2 commits intoAug 24, 2026
Merged
docs: align READMEs and RFCs with current code and AGENTS.md conventions#629mnoah1 merged 2 commits into
mnoah1 merged 2 commits into
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Updates the documentation to match the actual repository layout and code:
- Replaces all stale CLAUDE.md references with AGENTS.md, the authoritative conventions file.
- Fixes the project-layout description in README.md and submitqueue/README.md: shared code lives under platform/, not the now-removed top-level entity/extension/core/ directories.
- Expands the empty submitqueue/orchestrator/README.md with the pipeline stages it runs.
- Updates Stovepipe READMEs to reflect Ping + Ingest RPCs and the full ingest → process → build → buildsignal → record pipeline, plus DLQ reconcilers.
- Corrects fully-qualified gRPC service names in service/README.md and TESTING.md to use the uber.* proto packages.
- Corrects Runway topic names in doc/rfc/runway/workflow.md to match the actual TopicKey constants (merge-conflict-check, runway-merge, merge-conflict-check-signal, merge-signal).
- Clarifies integration-test Makefile targets in TESTING.md and removes the non-existent integration-test-{service} placeholder.
- Fixes the stale TODO line-number reference in modular-queue-wiring.md.
behinddwalls
marked this pull request as ready for review
August 21, 2026 18:39
mnoah1
approved these changes
Aug 24, 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
Reviewers
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.
Updates the documentation to match the actual repository layout and code: