Sweep docs em dashes and stale refs#113
Merged
Merged
Conversation
Three definite stale references fixed: - docs/examples/10-langfuse-observability.md: spec_version='0.26.0' in example trace output now reads '0.38.0' (current pin). - docs/concepts/parallel-branches.md: dropped the dangling "v0.16.1" qualifier from the retry attempt_index propagation reference. Behavior is current; the version pin was leftover. - docs/agent/non-obvious-shapes.md: compiled.attach_observer corrected to graph.attach_observer for variable-name consistency with the rest of the docs. Em-dash sweep across the user-facing docs: 130 instances removed across 17 files. Per-instance replacement was contextual (colons, semicolons, restructured asides) to keep prose natural. Reference sections that listed cross-links as "[link] -- description" now use "[link]: description"; inline emphasis dashes drop into the surrounding clause. Regenerated AGENTS.md and the _patterns/ mirror; mkdocs strict build remains clean. Spec section-number references (e.g. observability §5.5, §8.4.1) were intentionally not verified against the current v0.38.0 submodule; deferred to the next spec-bump release prep.
There was a problem hiding this comment.
Pull request overview
Docs polish sweep: removes em dashes from user-facing docs (replacing with colons/semicolons/restructured prose) and fixes three stale references (spec version, dangling version qualifier, variable-name typo). The bundled AGENTS.md is regenerated to match.
Changes:
- Replaced ~130 em dashes across 17 docs with contextual punctuation (colons, semicolons, parenthetical asides).
- Fixed stale refs:
spec_version='0.26.0'→'0.38.0'; droppedv0.16.1qualifier;compiled.attach_observer→graph.attach_observer. - Regenerated
src/openarmature/AGENTS.mdand updated CHANGELOG.
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| CHANGELOG.md | Documents the docs sweep under Unreleased/Changed. |
| docs/agent/non-obvious-shapes.md | Em-dash sweep plus graph.attach_observer fix. |
| docs/agent/tldr.md | Em-dash → colon in TL;DR. |
| docs/concepts/checkpointing.md | Em-dash → colon/period. |
| docs/concepts/fan-out.md | Em-dash → semicolon/colon. |
| docs/concepts/llms.md | Em-dashes → colons in bullets/comments. |
| docs/concepts/observability.md | Largest restructuring; em-dashes → colons/semicolons. |
| docs/concepts/parallel-branches.md | Drops stale v0.16.1 qualifier. |
| docs/concepts/prompts.md | Em-dash → colon. |
| docs/concepts/state-and-reducers.md | Em-dash → colon. |
| docs/examples/07-multimodal-prompt.md | Em-dash → semicolon/period. |
| docs/examples/10-langfuse-observability.md | Updates spec_version to 0.38.0 and em-dash sweep. |
| docs/model-providers/authoring.md | Em-dash → colon in link text. |
| docs/model-providers/vllm.md | Em-dash sweep across headings/comments. |
| docs/patterns/*.md | Em-dash sweep across pattern docs. |
| src/openarmature/_patterns/*.md | Em-dash sweep in bundled pattern sources. |
| src/openarmature/AGENTS.md | Regenerated to reflect docs changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jun 1, 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
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
Third of five docs-polish items. Deep docs sweep, audit-first.
Three definite stale references fixed:
docs/examples/10-langfuse-observability.md: example trace output'sspec_version='0.26.0'now reads'0.38.0'(current pinned spec).docs/concepts/parallel-branches.md: dropped the danglingv0.16.1qualifier from the retry attempt_index propagation reference. The behavior is current; the version pin was leftover from when the proposal landed.docs/agent/non-obvious-shapes.md:compiled.attach_observercorrected tograph.attach_observerfor variable-name consistency with every other example in the docs.Em-dash sweep:
130 em dashes removed across 17 user-facing docs, per the convention set during PR #111's patterns expansion. Replacements were contextual (colons, semicolons, restructured asides) rather than mechanical; reference sections that listed cross-links as
[link] -- descriptionnow use[link]: description, inline emphasis dashes drop into the surrounding clause.The two highest-em-dash files (
docs/agent/non-obvious-shapes.mdat 30,docs/concepts/observability.mdat 28) saw the most prose restructuring. mkdocs strict build remains clean post-sweep.Deferred:
Spec section-number references (e.g.
observability §5.5,§8.4.1,§8.6) intentionally not verified against the current v0.38.0 submodule. Worth a spot-check at next spec-bump release prep when we'd be touching the submodule anyway.Test plan
uv run pytest -q(1080 pass, no regressions; drift test green after AGENTS.md regen)uv run mkdocs build --strictclean (no broken intra-docs links)ruff check+ruff format --checkcleandocs/mkdocs serveand skim the highest-restructured pages (non-obvious-shapes.md,observability.md) for any prose that reads brokenOut of scope