docs: split the user guide into per-topic pages under docs/ - #415
Draft
shimib wants to merge 1 commit into
Draft
Conversation
Merged
The README had grown past 1000 lines and serves four different readers at
once (evaluator, operator, developer, SRE). Split it into one page per
topic and shrink the README to a hub: overview, concepts, deployment
quickstart, and a documentation map.
Content is moved verbatim (headings re-leveled, intra-document anchors
rewritten to cross-file links); no prose changes beyond the one line that
described the old single-file layout.
New pages:
- docs/transports.md transport config, queue/topic entry fields,
backend compatibility, per-implementation reference
- docs/gates.md dispatch gate reference
- docs/worker-pools.md pool config + merge policy reference
- docs/requests-and-results.md message formats, wire envelope, body transforms
- docs/observability.md Prometheus + PromQL cookbook, OTel tracing
- docs/reference/cli.md command line parameters
All cross-file anchors verified to resolve; existing inbound links to the
README anchors that remain (concepts, deployment, development) are
unaffected.
Signed-off-by: Shimi Bandiel <shimib@google.com>
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
1 participant
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.
What does this PR do?
Draft — for structure review. Splits the (restructured) user guide into one page per topic under
docs/and shrinks the README to a hub: overview, concepts, deployment quickstart, and a documentation map.Content is moved verbatim — headings re-leveled, intra-document anchors rewritten to cross-file links. The only prose edit is the one line that described the old single-file layout. Review is best done page-by-page rather than via the diff (the diff is dominated by the moves):
docs/guides/is untouched and remains the home for task-oriented guides.Notes for review
docs/dispatch-budget.md→README.md#dispatch-gates) still resolve: the concepts sections keep their anchors in the README.Rebased onto
mainafter the restructure (#411) merged.