[AAASM-4187] 📝 (readme): Reword intro from router model to aggregation model#55
Merged
Merged
Conversation
|
Contributor
Author
Claude Code review — AAASM-4187Verdict: approve-ready (comment-only; Pioneer sign-off yours).
— Claude Code review |
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
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.



Description
Rewords the
README.mdintro paragraph from the superseded router/link modelto the current aggregation model, resolving a doc self-contradiction that was
a residual of AAASM-4174.
AAASM-4174 rewrote the README's "How content reaches the site" section (and
AGGREGATION.md) to describe the aggregation pipeline — the hub builds eachcomponent's docs with its native toolchain and mounts them under stable subpaths
(
/core/,/python-sdk/,/node-sdk/,/go-sdk/) with a unified Pagefind index,deploying one combined site. The intro paragraph was left describing the old model
("the hub is the central router … linking to each component's own docs site root
rather than duplicating their content"), so it contradicted the same README's
pipeline section and
AGGREGATION.md.What changed: the intro now reads that the hub "aggregates the docs of every
independently versioned component — building each with its own native toolchain and
mounting it under a stable subpath (
/core/,/python-sdk/,/node-sdk/,/go-sdk/)— into one unified, searchable site," mirroring the pipeline section and
AGGREGATION.md. One line changed in substance; no other content touched..claude/CLAUDE.md— deferred as a follow-up. That file also carries therouter/link framing, but it is threaded through multiple sections (the "What this
repo is" description, the versioning-channel-model note, and the whole
"Documentation conventions" philosophy, which is built around "link out, don't
duplicate"). That is a substantive multi-part rewrite, not a quick analogous
same-fix reword, so it is intentionally left out of this PR to keep scope tight.
Also noted (out of scope, potential further follow-up): a few other README
sections outside the intro still use router/link phrasing — the "What's inside"
Documentation-index bullet, the component-map "router page" paragraph, and the
"content sourced from" bullet. These describe the
documentation.mdindex page'srouting role and were left untouched, as this ticket is scoped to the intro
paragraph only.
Type of Change
Related Issues
Documentation Checklist
cd docs && mdbook buildpasses locally with no warningsdocs/src/SUMMARY.md(N/A — README, not an mdBook page)