docs: remove em-dashes from doc prose and a duplicate (required) marker#3260
Merged
Conversation
Recast em-dash asides in prose strings with the correct punctuation (colon, semicolon, comma, or parentheses) across the Table sticky/resize hook docs, the theme guide, the LinkProvider and sticky-columns block descriptions, and the shell-side-nav/shell-top-nav page templates. Drop a literal '(required)' from the CircularProgress label description and dense overlay, since the prop already sets required: true and the CLI renders the marker on its own. Prose-only changes; no technical claims reworded, no information removed. Night Watch — Doc Reviewer
josephfarina
requested review from
cixzhang,
ejhammond,
imdreamrunner,
marie-lucas,
nynexman4464 and
thedjpetersen
as code owners
|
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 No new or modified components detected. Bundle Size Summary
Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
cixzhang
approved these changes
Jun 30, 2026
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.
Summary
Removes em-dashes from documentation prose and clears a duplicate
(required)marker, following the Doc Reviewer check 17 (AI-slop prose) rubric. Found by a full re-scan of all 789.doc.mjsfiles after the cron refresh; these are pre-existing tells, not new content.Changes (8 files, prose only)
Em-dash recasts (colon / semicolon / comma / parentheses per the right punctuation):
Table/useTableColumnResize.doc.mjs(3) andTable/useTableStickyColumns.doc.mjs(2) hook param/return descriptionscli/docs/theme.doc.mjs(2) guide proseLinkProvider/LinkProviderCustomLink.doc.mjsandTable/StickyColumnsHookUsage.doc.mjsblock descriptionspages/shell-side-navandpages/shell-top-navtemplate descriptions (parenthetical asides)Duplicate
(required)marker:lab/CircularProgress/CircularProgress.doc.mjslabeldescription (English + dense overlay) had a literal(required)while the prop already setsrequired: true. Removed the literal text so the marker renders once.What is intentionally left alone
——and the必填marker indocsZh(correct CJK punctuation, exempt)Component — Variantname/displayNamelabels (naming convention, exempt)2-4,h1-h6, etc.)//and/* */code comments and demo UI copyValidation
pnpm --filter @astryxdesign/core typecheck:docs: passnpx tsc --project packages/cli/tsconfig.template-docs.json --noEmit: passnode .github/scripts/api-cli-parity-test.mjs --no-baseline: 307 pass / 0 fail(required))Night Watch — Doc Reviewer