Skip to content

docs: replace em dashes in three doc prose descriptions - #5180

Open
josephfarina wants to merge 1 commit into
mainfrom
navi/docs/slop-41
Open

docs: replace em dashes in three doc prose descriptions#5180
josephfarina wants to merge 1 commit into
mainfrom
navi/docs/slop-41

Conversation

@josephfarina

Copy link
Copy Markdown
Contributor

What

Three prose description fields used an em dash where standard punctuation reads better. Recast each per the AI-slop rubric (check 17, A1), preserving meaning:

  • packages/cli/clients/cli/commands/theme-build.doc.mjs: em dash between two independent clauses becomes a semicolon ("stopping at the first failure; an app with several themes does not need a shell loop").
  • packages/core/src/BottomSheet/BottomSheet.doc.mjs: em dash before a continuation aside becomes a comma ("a shorter detent, resuming when they drag it back").
  • packages/core/src/TextArea/TextArea.doc.mjs: em dash introducing a clarifying definition becomes a colon ("user-perceived characters: an emoji or flag sequence counts as one").

Prose strings only. No wording, technical claims, or structure changed.

Checklist

  • pnpm --filter @astryxdesign/core typecheck:docs passes
  • template-docs tsc: no new errors (one pre-existing TS2307 in theme.template.ts on clean main, unrelated)
  • CLI --props / --help output verified for BottomSheet, TextArea, theme build
  • Files parse as ES modules
  • No em dashes, curly quotes, or ellipsis chars remain in the edited descriptions

Night Watch — Doc Reviewer

Recast em dashes with the appropriate punctuation in prose descriptions:
- theme-build command: semicolon between two independent clauses
- BottomSheet height prop: comma for the continuation aside
- TextArea maxLength prop: colon introducing the clarifying definition

Meaning unchanged; only typography normalized. Found during Night Watch doc review.
@vercel

vercel Bot commented Aug 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
astryx Ready Ready Preview Aug 18, 2026 9:17am

Request Review

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Aug 18, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Analysis Report

📚 Storybook Preview

View Storybook for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

🧪 Sandbox Preview

View Sandbox for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

Modified Components

BottomSheet (@astryxdesign/core) · View in Storybook
Metric Before After Delta
Bundle Size (ESM) N/A N/A N/A
Lines of Code N/A 2994 -
Complexity N/A Very High (244) -
TextArea (@astryxdesign/core) · View in Storybook
Metric Before After Delta
Bundle Size (ESM) N/A N/A N/A
Lines of Code N/A 421 -
Complexity N/A Very High (66) -

Bundle Size Summary

Package Size (ESM) Size (CJS) Gzipped
@astryxdesign/core N/A 4.8KB 1.2KB

Accessibility Audit

Status: No accessibility violations detected.


Generated by PR Enrichment workflow | Storybook | Sandbox | View full report

github-actions Bot added a commit that referenced this pull request Aug 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant