Scrub proposal/spec refs from example walk-throughs#121
Merged
chris-colinsky merged 1 commit intoJun 2, 2026
Conversation
Extends feedback_examples_no_spec_refs.md (which targets example
source files) to the docs/examples/ walk-throughs. Drops every
``proposal NNNN``, ``spec §N.N.N``, and ``spec v0.NN.0`` reference
from four files; concept-link targets stay intact, only the
parenthetical citation labels and explanatory phrases pointing at
spec sections come out. Replacement link text uses descriptive
user-facing language ("no double-export between them", "deriving
domain dicts from State", "caller metadata and reserved keys",
"the caller-metadata API").
Affected files:
- docs/examples/chat-with-multimodal.md
- docs/examples/fan-out-with-retry.md
- docs/examples/langfuse-observability.md
- docs/examples/production-observability.md
Same spirit as the rename PR's "drop the NN- prefix from link
text" pass: spec-process artifacts don't belong in user-facing
docs; the underlying concept pages do. Future example walk-
throughs should follow the same rule from the start.
There was a problem hiding this comment.
Pull request overview
Extends the project’s “no spec/proposal references in examples” documentation policy to the docs/examples/ walkthrough pages by removing parenthetical citations (proposal/spec section/version references) while keeping the underlying concept links intact.
Changes:
- Removes
proposal NNNN,spec §…, andspec v…references from four walkthrough pages. - Replaces citation-style link text with user-facing descriptive phrasing (or drops the phrase when redundant).
- Reflows a few sentences/line wraps to keep the prose readable after citation removal.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/examples/production-observability.md | Removes proposal/spec citations and replaces link text with descriptive concept phrasing. |
| docs/examples/langfuse-observability.md | Rewords a sentence to remove proposal attribution while preserving meaning. |
| docs/examples/fan-out-with-retry.md | Drops a spec-resume citation clause, leaving the explanation supported by concept links below. |
| docs/examples/chat-with-multimodal.md | Removes proposal/spec version parenthetical from the “What it teaches” bullet and reflows text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chris-colinsky
deleted the
refactor/scrub-proposal-refs-from-walk-throughs
branch
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.
Summary
Extends the existing
feedback_examples_no_spec_refs.mdrule (which targetsexamples/*/main.pysource comments) to thedocs/examples/walk-through pages. Drops everyproposal NNNN,spec §N.N.N, andspec v0.NN.0reference from four affected files. Concept-link targets stay intact; only the parenthetical citation labels and explanatory phrases pointing at spec sections come out.Replacement link text uses descriptive user-facing language:
[proposal 0031 + the no-double-export claim][no double-export between them][proposal 0043, observability §8.4.1][deriving domain dicts from State][proposal 0034 + 0041 reserved keys][caller metadata and reserved keys]ships with proposal 0034's caller-metadata workis part of the caller-metadata APIWhere the spec reference was structurally redundant (the next sentence had a concept link doing the same job), the citation phrase comes out entirely without a replacement (
fan-out-with-retry.md).Same spirit as the rename PR's "drop the NN- prefix from link text" pass: spec-process artifacts don't belong in user-facing docs; the underlying concept pages do.
Files changed
docs/examples/chat-with-multimodal.mddocs/examples/fan-out-with-retry.mddocs/examples/langfuse-observability.mddocs/examples/production-observability.mdTest plan
git grep -nE 'proposal [0-9]{4}|spec v[0-9]|§[0-9]\.|spec §' docs/examples/returns zero matchesuv run mkdocs build --strictclean (no broken intra-docs links)