docs: drop em dashes from authored documentation - #826
Merged
Merged
Conversation
Clause breaks were using em dashes as a default separator. The same sentences now use commas, periods, or a colon on a short list label.
|
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
commit: |
# Conflicts: # website/docs/en/reference/configuration.mdx # website/docs/zh/reference/configuration.mdx
Restore literal AB8003 output, EN-dash ranges, and typographic quotes the sweep changed out of scope; fill placeholder table cells; use parentheses where a replaced dash pair became ambiguous; strip ASCII spaces around Chinese full-width commas and use colons for zh label lists.
This was referenced Sep 25, 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
repos/alone. Em dashes inside code samples and literal UI output (for exampleAB8003 — Origin …) are kept verbatim.Review
Independent review (change-risk-reviewer, GPT-5.6) of
git diff origin/main...HEAD; findings fixed in ab9110f and f3efef3:AB8003 — …Workbench output had been rewritten: restored in en/zh.,: nownone (rejected: …)/无(拒绝:…).hostSurface/Source placeholder—had becomenone, which reads as a real enum value: nownot applicable/不适用.AB4005trigger, CLI command-group labels, limitations facets,.envset, Workbench Origin guard, zh--plugin-root): rewritten with parentheses.create-agent-bundleminimal templateSKILL.mdapostrophe (now byte-identical to main).,(main has none), moved four line-leading,, and used:for zh label lists to match English and existing zh lists.docs/entry-conventions.mdheading slugs;check-diagnostics-coverage.mjsparsing unaffected; no generated or snapshot-asserted files changed.Test plan
pnpm docs:site:buildon f3efef3 (merged with currentorigin/main): typecheck, locale drift 0 failures, diagnostics coverage all documented, Rspress build + language parity, link check 0 broken links / 30545 anchors.skip-changeset.Root verification verdict: PASS+NOTES at
f3efef3655Base
b0b131bbf7(currentorigin/main), headf3efef3655, stable patch-ided60645ee1. The verdict pins this patch. An earlier pass atd7acd00aeeis superseded because the patch changed.Independent lanes, none run by the PR owner:
d7acd00aee:install,build,typecheck,lint,test:unit,docs:site:buildf3efef3655:build,docs:site:build,test:unitb0b131bbf7d7acd00aee, with three should-fix items. Rerun atf3efef3655shows all three fixed.AB8003quote still matches what the Workbench prints. No page errors.The audit's three should-fix items at
d7acd00aeewereAB8003code spans that no longer matched the UI text, table cells that started with a comma, and ASCII spaces around full-width commas in 66 zh lines. The owner's follow-up commits fixed all three. The rerun shows 0 changed inline code spans,noneand无placeholders, and no padded commas.Notes:
noneor无for empty table cells.packages/create-agent-bundle/templates/minimal/src/skills/getting-started/SKILL.mdchanges a curly apostrophe in the skilldescription, so the scaffolded bytes differ. It is not a README. No test hashes template bytes, soskip-changesetis still defensible as no observable change.docs/plans,docs/audits, and inAGENTS.md. That matches the stated scope.CI at this head was still running when this verdict was written. Merge after it is green.
Rerunnable evidence lives in the root's local trail. The scripts are
check1_punct_only.py,check3_inline_code_spans.py,check5_zh_punct.py, andlive.mjs.