docs:punctuation-V2#264
Open
tokyojen wants to merge 20 commits into
Open
Conversation
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe PR adds capitalization and vocabulary guidelines, replaces proper-noun guidance, expands punctuation rules and spacing documentation, and updates metadata and descriptions across conversational-design, support, component, and blog documentation. ChangesDocumentation guideline updates
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request comprehensively updates the punctuation guidelines in 'punctuation.md' and applies a minor ellipsis fix in 'AI-and-UX-writing.md'. The reviewer feedback correctly identifies several style guide violations in the new content, including recommendations to avoid the Oxford comma, use contractions like 'don’t' instead of 'do not', and replace phrases like 'such as' with 'e.g.' to ensure alignment with the repository's documentation standards.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guidelines/language/punctuation.md`:
- Around line 210-229: The Minus sign − guideline has a spacing inconsistency
between its rule and the temperature example. Update the rule or the “The
temperature dropped to −12°C” example so running-text usage and
numeric/data-display usage follow the same stated spacing behavior.
In `@docs/guidelines/language/support-and-resources/AI-and-UX-writing.md`:
- Line 58: Update the “Blaming language” bullet in the documentation to use
matching quotation mark glyphs, replacing the closing straight double quote with
the corresponding curly right double quote.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6995bcc0-08fc-40ae-9900-fa3ac0f482e1
📒 Files selected for processing (2)
docs/guidelines/language/punctuation.mddocs/guidelines/language/support-and-resources/AI-and-UX-writing.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…ng.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guidelines/language/capitalization-and-proper-nouns.md`:
- Line 11: Remove the standalone empty heading from
docs/guidelines/language/capitalization-and-proper-nouns.md at lines 11-11 and
docs/guidelines/language/proper-nouns.md at lines 11-11 before selecting the
canonical page; no other content changes are needed.
- Line 53: Update the guidance at
docs/guidelines/language/capitalization-and-proper-nouns.md:53-53 to state the
lowercase rule for “email” directly, removing the inaccurate historical
justification. Apply the same wording at
docs/guidelines/language/proper-nouns.md:53-53 so both retained pages are
consistent.
- Line 141: Replace every [LINK] placeholder with the appropriate relative
Markdown link to the punctuation guideline in
docs/guidelines/language/capitalization-and-proper-nouns.md at lines 141, 183,
and 296, and in docs/guidelines/language/proper-nouns.md at lines 141, 183, and
296. Preserve the existing reference text while ensuring all cross-document
links use relative paths.
- Around line 1-8: The documentation contains duplicate capitalization guidance
and metadata across two pages. For
docs/guidelines/language/capitalization-and-proper-nouns.md lines 1-8, retain it
as the single canonical page or remove it; for
docs/guidelines/language/proper-nouns.md lines 4-9, remove the duplicate content
or convert the page into a redirect/alias targeting the existing proper-nouns
link, leaving only one published source of truth.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1ee40b73-4963-42df-b935-44a70f9435a1
📒 Files selected for processing (3)
docs/guidelines/language/capitalization-and-proper-nouns.mddocs/guidelines/language/proper-nouns.mddocs/guidelines/language/punctuation.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/guidelines/language/punctuation.md
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/guidelines/language/vocaulary (1)
408-506: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winNest "Last vs. latest vs. recent" and "Pending vs. waiting vs. queued" under "Time-based vocabulary".
Both subsections use
##(h2), the same level as their parent "Time-based vocabulary" heading, instead of###(h3). This flattens the hierarchy and will misrepresent the section structure in the sidebar/TOC.✏️ Proposed heading-level fix
-## Last vs. latest vs. recent +### Last vs. latest vs. recent-## Pending vs. waiting vs. queued +### Pending vs. waiting vs. queued🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guidelines/language/vocaulary` around lines 408 - 506, Update the “Last vs. latest vs. recent” and “Pending vs. waiting vs. queued” headings under “Time-based vocabulary” from level-2 headings to level-3 headings, preserving the existing content and hierarchy for sidebar/TOC generation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guidelines/language/vocaulary`:
- Around line 1-9: Rename the new Vocabulary documentation file from “vocaulary”
to “vocabulary.md”, preserving its front matter and content so the generated
slug and existing grammar-and-vocabulary navigation remain consistent.
- Around line 513-527: Update the billion row’s “10^9^” and “10^12^” values to
use Docusaurus-supported <sup> markup, preserving the displayed exponents
without literal caret characters. Leave the surrounding translations and table
structure unchanged.
---
Nitpick comments:
In `@docs/guidelines/language/vocaulary`:
- Around line 408-506: Update the “Last vs. latest vs. recent” and “Pending vs.
waiting vs. queued” headings under “Time-based vocabulary” from level-2 headings
to level-3 headings, preserving the existing content and hierarchy for
sidebar/TOC generation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: d04dc2a3-f23c-46d6-8a08-5a0d07b8a39f
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (8)
blog/tags.ymldocs/components/input-date-time/code.mdxdocs/guidelines/conversational-design/designing-conversations/ad-hoc-conversations.mddocs/guidelines/conversational-design/designing-conversations/ending-conversations.mddocs/guidelines/conversational-design/designing-conversations/handling-errors.mddocs/guidelines/language/punctuation.mddocs/guidelines/language/vocaularydocs/home/support/faq.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/guidelines/language/punctuation.md
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.
💡 What is the current behavior?
GitHub Issue Number: #
🆕 What is the new behavior?
👨💻 Help & support
Summary by CodeRabbit