docs: improve content and punctuation - #910
Merged
Merged
Conversation
Removes 886 em dashes across the docs site and the library source comments. Each one is replaced by the punctuation it was standing in for rather than by a single substitute: - a colon for definition lists and list introductions - a period where it joined two independent clauses - commas, or parentheses, for a parenthetical aside - a real conjunction where the two halves needed one Every occurrence in the package was a comment or JSDoc, so no string literal, prop, or rendered output changed. Two console.warn messages and two test names are the only non-comment edits; no test asserts on text spanning a dash. Left in place on purpose: - CHANGELOG.md, which is a historical record of shipped releases - the root README, CONTRIBUTING, DEVELOPMENT and agents.md - the eight "no value" placeholders in the timeline stress-test stats table, where an em dash is standard table typography
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Important Review skippedToo many files! This PR contains 228 files, which is 128 over the limit of 100. To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (228)
You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
commit: |
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
1 participant
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.
A punctuation and phrasing pass over the docs site and the library's source comments.
What changed
886 em dashes across 228 files are replaced with plainer punctuation. Each one got the mark it was standing in for rather than a single blanket substitute:
`--rs-space-5` — 16px spacing`--rs-space-5`: 16px spacing**Accessibility first** — Every component…**Accessibility first.** Every component…a no-op pass-through — children render…a no-op pass-through. Children render…the Today button — wired through actionsRef — to jump backthe Today button, wired through actionsRef, to jump backOne phrase,
to own the state — needed when…, appeared 12 times across the component docs and now readsto own the state. Do this when…everywhere.Nine frontmatter descriptions are rephrased rather than re-punctuated. A
:inside an unquoted YAML scalar reads as a nested mapping, so those took a period or a conjunction instead.Scope
Every occurrence inside
packages/raystackwas a comment or JSDoc block, so no string literal, prop, or rendered output changed. The only non-comment edits are twoconsole.warnmessages and two test names, and no test asserts on text spanning a dash.Left in place on purpose:
CHANGELOG.md, a historical record of shipped releasesREADME,CONTRIBUTING,DEVELOPMENTandagents.mdVerification
pnpm test:apsara— 2,707 passed, 1 skippednpm run build:apsara— succeedsnext buildinapps/www— all 187 pages generate, covering every docs routemain; none in files this PR touchesEvery changed file was checked to contain only punctuation edits: each removed line held a dash, and added and removed line counts match at 838 each.