Skip to content

Review 5354

Cindy Zhang edited this page Aug 23, 2026 · 1 revision

#5354 — docs: replace em dashes and curly quotes in CLI and component doc prose

josephfarina · OPEN · view on GitHub

Verdict: approve with nits

Head reviewed: 9d49a975517e8043b8c98fc4730bef5d8696b8ab

Problem

Em dashes and curly apostrophes across eleven CLI and core doc files — the same AI-slop tell the earlier deslop sweeps targeted.

Solution

Prose recast with plain punctuation; curly apostrophes replaced with straight ones. No technical claim reworded.

Impact

Docsite and CLI doc readers. No runtime code touched.

API

No API change.

Theme targets

No new theme targets.

Breaking

  • API — no. Visual — no, prose only. Theme — no.

Performance & resources

Nothing — no runtime code in the diff.

Risk class

Low-risk — no new API surface, no behavior regression, no performance regression.

Judgement

approve with a nit

1. `response-types.doc.mjs` feeds a generated README table, so editing its
   descriptions puts the CLI README out of sync
   → `readme-gen.test.mjs` is red and the PR cannot merge. Verified on a clean
     main worktree: main passes, this diff fails, and the generator rewrites 45
     lines of the response-types table
                                      · packages/cli/test/readme-gen.test.mjs:25

The review, as posted

Thanks. The response-types table in the CLI README is generated from these descriptions — pnpm -F @astryxdesign/cli readme and commit, then the red test goes green.

What changed before posting

Posted as drafted.

Clone this wiki locally