docs: replace em dashes and curly quotes in CLI and component doc prose - #5354
Open
josephfarina wants to merge 1 commit into
Open
docs: replace em dashes and curly quotes in CLI and component doc prose#5354josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
Recast em dashes as colons, commas, semicolons, or parentheses and straighten curly apostrophes across docs, template, theme, typography, response-type, Selector, SideNav, useContainerReveal, Field, and Thumbnail doc prose. Prose strings only; meaning preserved. Found during Night Watch doc review.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR Modified ComponentsField (@astryxdesign/core) · View in Storybook
Selector (@astryxdesign/core) · View in Storybook
SideNav (@astryxdesign/core) · View in Storybook
Thumbnail (@astryxdesign/core) · View in Storybook
Bundle Size Summary
Accessibility AuditStatus: 1 accessibility violation(s) found — 1 serious. Thumbnail - 1 issue(s)
Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
cixzhang
approved these changes
Aug 23, 2026
cixzhang
left a comment
cixzhang
left a comment
Contributor
There was a problem hiding this comment.
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.
[Reviewed by Robohands]
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
2 participants
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.
What
Replace AI-slop typographic tells (em dashes and curly apostrophes) in doc prose across the CLI and component docs. Prose strings only; no technical claim was reworded and no information removed.
Files and recasts:
packages/cli/api/docs/docs.doc.mjs— em dash aside to commaspackages/cli/api/template/template.doc.mjs— aside to parentheses; sentence break to periodpackages/cli/api/theme/themeTemplate.doc.mjs— list intro to colon/comma; receipt aside to periodpackages/cli/clients/cli/commands/theme-template.doc.mjs— same as abovepackages/cli/assets/docs/typography.doc.mjs— em dash to colon; ellipsis "..." spelled as "and so on"; paired aside to parenthesespackages/cli/foundation/response/response-types.doc.mjs— two receipt asides to periodspackages/core/src/Selector/Selector.doc.mjs— sizing aside to commapackages/core/src/SideNav/SideNav.doc.mjs— isSelected aside to colon; label clause to semicolon (3 overlays each)packages/core/src/hooks/useContainerReveal.doc.mjs— three em dash asides to colonspackages/core/src/Field/Field.doc.mjs— curly apostrophe to straight (2)packages/core/src/Thumbnail/Thumbnail.doc.mjs— curly apostrophe to straightChinese CJK double em dash, numeric ranges, code comments, and
Component — Variantlabels were left as-is.Checklist
pnpm --filter @astryxdesign/core typecheck:docspassespnpm exec tsc --project packages/cli/tsconfig.template-docs.json --noEmitclean for edited files (only the pre-existingtheme.template.ts:83TS2307 remains, untouched here).doc.mjsparses (import()check)--propsand--lang denseoutput verified for Selector and SideNavNight Watch — Doc Reviewer