Website: Public-facing developer guides section#229
Draft
aidanfnv wants to merge 3 commits into
Draft
Conversation
…lumbing-prose scrubs) This branch is the holding area for the developer-guides prose work while the sibling site-merge integration branch ships a thin developer-guides surface (main-state plus three structural compensations — see the site-merge revert commit for details). Restored on this branch: - `developer_guides/index.rst`: the marketing-flow-then-docs-scaffold rewrite (plain title, intro paragraphs naming the reading order, 5-card sphinx_design grid covering Inference pipeline overview / Config system / Add a new method / Usage patterns / Interactive serving, a "Where these guides fit" closing block with cross-links to /quickstart-now-get_started and /api/index, and a :hidden: toctree of all five sub-pages). - `:orphan:` removed from `usage_patterns.rst` and `interactive_serving.rst` so they can sit non-orphan inside the rewritten index's toctree. - Plumbing-prose scrubs across the sub-pages (`flashdreams-run` / `uv` references in narrative prose were taken out and kept only in code blocks). PR target: `dev/aidanf/flashdreams-site-merge`. When this branch is ready, the merge brings the developer-guides text content into the public-website integration line. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Three content conflicts plus two stale cross-refs surfaced by `sphinx-build -W` after the merge. Content conflicts (all "keep this branch"): - `docs/source/developer_guides/config_system.rst` - `docs/source/developer_guides/interactive_serving.rst` - `docs/source/developer_guides/new_integration.rst` Site-merge holds the main-state prose for the developer guides (per 7029ba5 "Revert developer_guides text/prose to main"); this branch's entire purpose is the inverse — re-introduce the rewritten prose (per 5249fc3 "Restore developer_guides text/prose ..."). Keep this branch's version on every conflict. Stale cross-refs uncovered by `sphinx-build -W`: - `docs/source/developer_guides/index.rst:75-78`: `:doc:\`/benchmarks\`` → `:doc:\`/models/index\``, `:doc:\`/get_started\`` → `:doc:\`/quickstart/index\``. - `docs/source/developer_guides/interactive_serving.rst:63`: `:doc:\`/get_started\`` → `:doc:\`/quickstart/index\``. These refs were written assuming the flattened `benchmarks.rst` / `get_started.rst` shape that the rebase sister-PRs apply. On site-merge (this branch's base after the merge) the Benchmarks tab targets `models/index` and the Get Started tab targets `quickstart/index`.
…hdreams_site/dev_guides_text
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.
No description provided.