Skip to content

docs(cli): recast em dashes in elevation, i18n, and getting-started prose - #4633

Merged
josephfarina merged 1 commit into
mainfrom
navi/docs/slop-28
Aug 2, 2026
Merged

docs(cli): recast em dashes in elevation, i18n, and getting-started prose#4633
josephfarina merged 1 commit into
mainfrom
navi/docs/slop-28

Conversation

@josephfarina

Copy link
Copy Markdown
Contributor

Summary

Recasts 18 prose em-dash asides to semicolons across three CLI guide docs (check 17 / A1). Prose only, meaning preserved.

  • elevation.doc.mjs (11)
  • internationalization.doc.mjs (6)
  • getting-started.doc.mjs (1)

Context

These tells sat unfixed for ~2 weeks because earlier runs deferred them to the doc-overlay PR #4117. That PR edits the pre-restructure packages/cli/docs/ path, which no longer exists on main after the CLI restructure moved docs to packages/cli/assets/docs/. The files now live at the new path and are owned by no open PR, so they are safe to fix directly here.

Left untouched (exempt)

  • Code comments (//) and the {/* ... */} JSX comment inside the i18n example block
  • The ⟦…⟧ pseudo-locale example string
  • Numeric/identifier ranges

Validation

  • pnpm --filter @astryxdesign/core typecheck:docs: pass
  • All three files parse as ESM
  • Rendered astryx docs <topic> for all three: no prose em dashes (the 2 in i18n output are the exempt code comments)

Night Watch — Doc Reviewer

…rose

Recast 18 prose em-dash asides to semicolons across three cli guide docs
(now at packages/cli/assets/docs/ after the restructure): elevation (11),
internationalization (6), getting-started (1). Independent-clause asides, so
a semicolon carries the same meaning. Prose only; code comments, the {/* */}
JSX comment, the pseudo-locale example, and numeric ranges left untouched.

These were previously deferred behind the stalled overlay PR #4117, which
edits the pre-restructure packages/cli/docs/ path that no longer exists on
main; the files now live at assets/docs/ and are owned by no open PR.

Night Watch — Doc Reviewer
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Aug 1, 2026
@vercel

vercel Bot commented Aug 1, 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 1, 2026 9:23am

Request Review

@github-actions

github-actions Bot commented Aug 1, 2026

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.

No new or modified components detected.

Bundle Size Summary

No component packages changed.

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 1, 2026
@josephfarina
josephfarina merged commit 8e63bf3 into main Aug 2, 2026
18 checks passed
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