Skip to content

docs: drop em dashes from authored documentation - #826

Open
ScriptedAlchemy wants to merge 1 commit into
mainfrom
docs/unslop-prose
Open

ScriptedAlchemy wants to merge 1 commit into
mainfrom
docs/unslop-prose

Conversation

@ScriptedAlchemy

Copy link
Copy Markdown
Owner

Summary

  • Replace em dashes in hand-written docs, in both English and Chinese, with commas, periods, or a colon on a short list label.
  • Leave generated pages, changelogs, historical plans and audits, and repos/ alone.
  • Keep diagnostic code ranges, and quoted error text, in the form the coverage checker and the hosts already print.

Test plan

  • pnpm docs:site:build (typecheck, locale drift, diagnostics coverage, Rspress build, link check: 0 broken links)
  • Publishable package edits are README punctuation only, so this uses skip-changeset.

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: 4df4c1f

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: 4df4c1f

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