Skip to content

docs: drop em dashes from authored documentation - #826

Merged
ScriptedAlchemy merged 4 commits into
mainfrom
docs/unslop-prose
Sep 25, 2026
Merged

ScriptedAlchemy merged 4 commits into
mainfrom
docs/unslop-prose

Conversation

@ScriptedAlchemy

@ScriptedAlchemy ScriptedAlchemy commented Sep 17, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Replace em dashes in hand-written docs, in both English and Chinese, with commas, periods, parentheses, or a colon on a short list label.
  • Leave generated pages, changelogs, historical plans and audits, and repos/ alone. Em dashes inside code samples and literal UI output (for example AB8003 — Origin …) are kept verbatim.
  • Keep EN-dash diagnostic ranges, typographic quotes, and scaffolded template bytes unchanged.

Review

Independent review (change-risk-reviewer, GPT-5.6) of git diff origin/main...HEAD; findings fixed in ab9110f and f3efef3:

  • Literal AB8003 — … Workbench output had been rewritten: restored in en/zh.
  • Two runtime-environment table cells had become a bare ,: now none (rejected: …) / 无(拒绝:…).
  • hostSurface/Source placeholder — had become none, which reads as a real enum value: now not applicable / 不适用.
  • Ambiguous appositions (README intro, AB4005 trigger, CLI command-group labels, limitations facets, .env set, Workbench Origin guard, zh --plugin-root): rewritten with parentheses.
  • Out-of-scope edits reverted: EN-dash ranges spelled as "to"/"到", smart quotes flattened, and the create-agent-bundle minimal template SKILL.md apostrophe (now byte-identical to main).
  • zh: removed ASCII spaces around , (main has none), moved four line-leading ,, and used : for zh label lists to match English and existing zh lists.
  • Checked clean: no inbound links to old docs/entry-conventions.md heading slugs; check-diagnostics-coverage.mjs parsing unaffected; no generated or snapshot-asserted files changed.

Test plan

  • pnpm docs:site:build on f3efef3 (merged with current origin/main): typecheck, locale drift 0 failures, diagnostics coverage all documented, Rspress build + language parity, link check 0 broken links / 30545 anchors.
  • Publishable package edits are README punctuation only, so this uses skip-changeset.

Root verification verdict: PASS+NOTES at f3efef3655

Base b0b131bbf7 (current origin/main), head f3efef3655, stable patch-id ed60645ee1. The verdict pins this patch. An earlier pass at d7acd00aee is superseded because the patch changed.

Independent lanes, none run by the PR owner:

Lane Model Result
Gates at d7acd00aee: install, build, typecheck, lint, test:unit, docs:site:build Grok 4.7 (commands only) PASS. 4483 passed, 0 failed. 0 broken links.
Gates at f3efef3655: build, docs:site:build, test:unit root PASS. 4483 passed, 0 failed. 0 broken links across 30551 anchors. Locale drift 0. Language parity OK.
Trunk baseline at b0b131bbf7 Grok 4.7 (commands only) PASS. The emitted page set is identical to head, 123 HTML pages each.
Scripted diff audit Claude Fable 5.1 PASS+NOTES at d7acd00aee, with three should-fix items. Rerun at f3efef3655 shows all three fixed.
Live render at 1440x900, headless Chromium, 8 changed pages in en and zh, head vs trunk root PASS. On trunk those pages carry 18 to 349 em dashes each in prose. At head they carry 0. No table cell starts with a comma. No space-padded full-width comma. Every rendered AB8003 quote still matches what the Workbench prints. No page errors.

The audit's three should-fix items at d7acd00aee were AB8003 code 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, none and 无 placeholders, and no padded commas.

Notes:

  • The punctuation-only script flags 44 hunks at head that are not strictly punctuation. All are benign rewordings. They are sentence splits that change case, en-dash ranges written as "to" or "到", and none or 无 for empty table cells.
  • packages/create-agent-bundle/templates/minimal/src/skills/getting-started/SKILL.md changes a curly apostrophe in the skill description, so the scaffolded bytes differ. It is not a README. No test hashes template bytes, so skip-changeset is still defensible as no observable change.
  • Em dashes remain in fenced code comments, in docs/plans, docs/audits, and in AGENTS.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, and live.mjs.

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.
@ScriptedAlchemy ScriptedAlchemy added documentation Improvements or additions to documentation skip-changeset PR changes a publishable package but ships no observable change; changeset not required labels Sep 17, 2026
@changeset-bot

changeset-bot Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f3efef3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@pkg-pr-new

pkg-pr-new Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle@826
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/create-agent-bundle@826
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/rsc-markdown-stream@826
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/@agent-bundle/runtime@826

commit: f3efef3

# 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.
@ScriptedAlchemy
ScriptedAlchemy merged commit 96b2519 into main Sep 25, 2026
18 checks passed
@ScriptedAlchemy
ScriptedAlchemy deleted the docs/unslop-prose branch September 25, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skip-changeset PR changes a publishable package but ships no observable change; changeset not required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant