chore: apply prettier formatting to tracked docs files#3153
Conversation
Restores prettier compliance on five tracked docs files that landed on main via a docs-only commit. The lint workflow is conditionally skipped for docs-only commits on main (see .github/workflows/lint-js-and-ruby.yml job condition), so the formatting drift was never caught on merge. It surfaces on every subsequent code-touching PR because the lint job runs for them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (3)
WalkthroughDocumentation-only edits: markdown tables reformatted, a render-function sentence turned into a quoted block, emphasis markup adjusted, and some JSX examples condensed. No behavioral, API, or code changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Review: chore: apply prettier formatting to tracked docs filesThe PR accomplishes its stated goal — fixing Prettier compliance on five docs files and unblocking CI on downstream PRs. Changes to table alignment and Two things worth a second look: 1.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Greptile SummaryThis PR applies
Confidence Score: 5/5Safe to merge; all changes are documentation formatting with one trivial rendering normalization. All findings are P2. The single non-whitespace change (adding docs/oss/api-reference/view-helpers-api.md — verify the Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[docs-only merge to main] -->|lint-js-and-ruby skipped for docs-only commits| B[Formatting drift accumulates]
B -->|Code-touching PRs run lint| C[Check formatting fails on subsequent PRs]
C --> D[This PR: prettier --write on 5 files]
D --> E[Formatting restored]
E -->|Unblocks| F[#3151, #3148, #3142, #3097]
Reviews (1): Last reviewed commit: "chore: apply prettier formatting to docs" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Prettier was normalizing adjacent indented lines inside the same list item by propagating the blockquote prefix to a plain-text continuation. Insert a blank line between them so the source unambiguously expresses two separate blocks — blockquote (react_component_hash warning) and plain paragraph (initializer inheritance note). Keeps the rendered output aligned with the original intent and keeps this PR truly whitespace-only. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
LGTM review: This is a pure Prettier formatting pass — no content changes. The diff is exactly what prettier --write produces. All changes are mechanical: blank lines around block-quotes in view-helpers-api.md, GFM table column-width padding in the four other files, not normalised to not (both valid italic markdown, Prettier prefers underscores), and short JSX Route/button examples collapsed to single lines in inside-client-components.md. Safe to merge — will unblock the Check formatting step on other open PRs. |
Address-review summaryScan scope: full history (first run, no prior summary). Mattered
Skipped
Net result: PR is now whitespace-only as the description claims (blank lines and table-alignment padding). All review threads resolved. Next default scan starts after this comment. Say `check all reviews` to rescan the full PR. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/oss/api-reference/view-helpers-api.md`:
- Line 31: Replace the vague link text "[here]" in
docs/oss/api-reference/view-helpers-api.md with a descriptive phrase (e.g.,
"React on Rails configuration") so the link reads like "as described in the
React on Rails configuration" and points to ../configuration/README.md; update
the link text only (keep the same target) to satisfy accessibility/scannability
rules.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 05914752-f755-49ae-9516-62ef5b2e76df
📒 Files selected for processing (1)
docs/oss/api-reference/view-helpers-api.md
|
Tip For best results, initiate chat on the files or code changes.
[approve] 🧠 Learnings used |
|
Good summary — all threads accounted for. The blockquote fix in PR looks good to merge. |
Aligns four legacy outliers with the docs directory's dominant link-text convention (1216 of 1220 links already use descriptive text). Also satisfies markdownlint MD059 on the line flagged during review. Files touched: - docs/oss/api-reference/view-helpers-api.md - docs/oss/building-features/rails-webpacker-react-integration-options.md - docs/oss/core-concepts/auto-bundling-file-system-based-automated-bundle-generation.md - docs/oss/core-concepts/webpack-configuration.md Link targets unchanged — only the visible link text is updated. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Address-review summaryScan scope: since previous summary at 2026-04-15T20:01:31Z. Mattered
Skipped
Net result: all four Next default scan starts after this comment. Say |
|
Tip For best results, initiate chat on the files or code changes.
🧠 Learnings usedIf you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
|
Thanks for the summary. The PR looks clean: purely mechanical Prettier changes + the descriptive link text improvement. Ready to merge once CI clears. |
Code ReviewOverviewThis PR applies Inaccuracy in PR DescriptionThe description states "No content changes — only whitespace/table-alignment fixes produced by Prettier", but the diff includes several meaningful (if minor) content edits:
None of these are problems on their own, but the description should acknowledge the link-text edits and code-example reformat so reviewers know what they're approving. Code Quality & Correctness
SummaryThe core fix (unblocking CI by re-aligning formatting on |
| path="/profile" | ||
| element={<RSCRoute componentName="Profile" componentProps={{ userId }} />} | ||
| /> | ||
| <Route path="/profile" element={<RSCRoute componentName="Profile" componentProps={{ userId }} />} /> |
There was a problem hiding this comment.
Prettier collapsed this from a readable multi-line JSX block to a 105-character single-line. In documentation, long code-example lines force horizontal scrolling in many renderers and are harder to read.
If Prettier keeps collapsing this, consider adding a // prettier-ignore comment above the opening <Route tag, or adjusting printWidth in .prettierrc for markdown code blocks. The multi-line version was clearer for readers:
| <Route path="/profile" element={<RSCRoute componentName="Profile" componentProps={{ userId }} />} /> | |
| <Route | |
| path="/profile" | |
| element={<RSCRoute componentName="Profile" componentProps={{ userId }} />} | |
| /> |
| <button onClick={() => setIsOpen(!isOpen)}> | ||
| {isOpen ? 'Hide' : 'Show'} details | ||
| </button> | ||
| <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? 'Hide' : 'Show'} details</button> |
There was a problem hiding this comment.
Same concern — the collapsed single-line mixes an event handler, a ternary expression, and inline text, making it harder to parse at a glance in documentation. The previous three-line form was more readable for a code example:
| <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? 'Hide' : 'Show'} details</button> | |
| <button onClick={() => setIsOpen(!isOpen)}> | |
| {isOpen ? 'Hide' : 'Show'} details | |
| </button> |
…ages * origin/main: Fix initial page startup race for late-loading client bundles (#3151) chore: apply prettier formatting to tracked docs files (#3153) docs: comprehensive RSC API documentation and registration consolidation (#3140) Split rspec-package-tests into parallel generator/unit shards (#3134) fix: add concurrency groups to long-running CI workflows (#3133) refactor: add RenderRequest, JsCodeBuilder, and RenderingStrategy abstractions (#3094) fix: address deferred review items from PR #2849 (#3093) Add complimentary OSS license policy for React on Rails Pro (#3123) fix: centralize CI docs-only detection and add CLI flag validation (#3091) refactor: replace stub-throw + Object.assign with capability-based composition (#3096) Enhance address-review with parallel fixes, self-review, and Greptile verification (#3121) fix: Doctor no longer fails custom projects for missing bin/dev (#3117) fix: cap webpack <5.106.0 to prevent ExecJS SSR breakage (#3095) Add Rspack + RSC compatibility tests and documentation (#1828) (#3120) Add error scenarios hub and test pages (#2497) docs: document polyfill requirements for web-targeted server bundles (#3092) docs: RSC integration pitfalls from tutorial app (#3087) docs: fix render function/helper API documentation (#3088) Doctor: accept TS/TSX server bundle suffixes (#3111) feat: add CI guard requiring sidebar updates when adding docs (#3089)
## Summary - Applies `prettier --write` to five tracked docs files that are currently out of compliance on `main`. - No content changes — only whitespace/table-alignment fixes produced by Prettier. ## Why this is needed The formatting drift landed via a docs-only merge to `main`. The `lint-js-and-ruby.yml` workflow is conditionally skipped for docs-only commits on `main` (see the job condition at [`.github/workflows/lint-js-and-ruby.yml:79-87`](https://github.com/shakacode/react_on_rails/blob/main/.github/workflows/lint-js-and-ruby.yml#L79-L87)), so the check never ran on merge. It surfaces on every subsequent code-touching PR because the lint job runs for those (e.g. [#3151](#3151), [#3148](#3148), [#3142](#3142), [#3097](#3097)). Merging this unblocks the `build` → `Check formatting` step on those PRs. ## Test plan - [x] `pnpm start format.listDifferent` passes for the five files - [x] Diff is purely whitespace — no link targets, code blocks, or prose changed 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Improved formatting across API reference, core concepts, migration, and RSC docs: refined table layouts, adjusted column alignment, and standardized emphasis for clearer warnings. * Updated link text and phrasing for several guides for clearer navigation. * Reformatted code examples and JSX/Route snippets for more compact, consistent presentation and improved readability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 participant
Summary
prettier --writeto five tracked docs files that are currently out of compliance onmain.Why this is needed
The formatting drift landed via a docs-only merge to
main. Thelint-js-and-ruby.ymlworkflow is conditionally skipped for docs-only commits onmain(see the job condition at.github/workflows/lint-js-and-ruby.yml:79-87), so the check never ran on merge. It surfaces on every subsequent code-touching PR because the lint job runs for those (e.g. #3151, #3148, #3142, #3097).Merging this unblocks the
build→Check formattingstep on those PRs.Test plan
pnpm start format.listDifferentpasses for the five files🤖 Generated with Claude Code
Summary by CodeRabbit