docs: standardize warning syntax to GFM alert format#3115
Merged
Conversation
Convert 3 remaining `> **Warning:**` instances to `> [!WARNING]` for consistency with the 30+ GFM alerts already used across docs. Closes #3114 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Contributor
|
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 (3)
WalkthroughThree documentation files are updated to standardize warning syntax from bold-style ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
Contributor
|
The three conversions look correct and consistent with the GFM alert format used elsewhere in the docs. One instance was missed though — Should be converted to: Once that's addressed, the docs will be fully consistent. |
Greptile SummaryStandardizes the last 3 remaining Confidence Score: 5/5Safe to merge — documentation-only formatting change with no logic impact. All three changes are mechanical format conversions with no content modifications. The GFM alert syntax is correct in each file, including the indented blockquote inside a list item in docker-deployment.md. No code, configuration, or logic is touched. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Old format\n> **Warning:** message"] -->|"Converted in 3 files"| B["New format\n> [!WARNING]\n> message"]
B --> C["Consistent with 30+ existing\nGFM alerts across docs"]
Reviews (1): Last reviewed commit: "docs: standardize warning syntax to GFM ..." | Re-trigger Greptile |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
## Summary - Converts 3 remaining `> **Warning:**` instances to `> [!WARNING]` GFM alert syntax for consistency with the 30+ GFM alerts already used across docs ### Files updated - `docs/oss/building-features/testing-configuration.md` - `docs/oss/deployment/docker-deployment.md` - `docs/oss/migrating/rsc-troubleshooting.md` Closes #3114 ## Test plan - [ ] Verify rendered warnings display correctly on GitHub 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only formatting changes with no code or behavior impact. > > **Overview** > Updates docs to replace remaining `> **Warning:**` blockquotes with GitHub alert callouts (`> [!WARNING]`) for consistent rendering across the guides, including testing configuration, Kubernetes migration guidance, and RSC troubleshooting. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 96c2ae5. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated warning callout formatting across testing configuration, Docker deployment, and Kubernetes migration guidance documentation to use admonition-style warnings for improved consistency and readability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
## Summary - Converts 3 remaining `> **Warning:**` instances to `> [!WARNING]` GFM alert syntax for consistency with the 30+ GFM alerts already used across docs ### Files updated - `docs/oss/building-features/testing-configuration.md` - `docs/oss/deployment/docker-deployment.md` - `docs/oss/migrating/rsc-troubleshooting.md` Closes #3114 ## Test plan - [ ] Verify rendered warnings display correctly on GitHub 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only formatting changes with no code or behavior impact. > > **Overview** > Updates docs to replace remaining `> **Warning:**` blockquotes with GitHub alert callouts (`> [!WARNING]`) for consistent rendering across the guides, including testing configuration, Kubernetes migration guidance, and RSC troubleshooting. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 96c2ae5. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated warning callout formatting across testing configuration, Docker deployment, and Kubernetes migration guidance documentation to use admonition-style warnings for improved consistency and readability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
## Summary - Converts 3 remaining `> **Warning:**` instances to `> [!WARNING]` GFM alert syntax for consistency with the 30+ GFM alerts already used across docs ### Files updated - `docs/oss/building-features/testing-configuration.md` - `docs/oss/deployment/docker-deployment.md` - `docs/oss/migrating/rsc-troubleshooting.md` Closes #3114 ## Test plan - [ ] Verify rendered warnings display correctly on GitHub 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only formatting changes with no code or behavior impact. > > **Overview** > Updates docs to replace remaining `> **Warning:**` blockquotes with GitHub alert callouts (`> [!WARNING]`) for consistent rendering across the guides, including testing configuration, Kubernetes migration guidance, and RSC troubleshooting. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 96c2ae5. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated warning callout formatting across testing configuration, Docker deployment, and Kubernetes migration guidance documentation to use admonition-style warnings for improved consistency and readability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
…ages * origin/main: (44 commits) Consolidate CSP nonce sanitization into shared module (#2828) Add comprehensive --rsc-pro generator tests (#3098) fix: cross-env validation and docs for renderer password (#3090) Improve package metadata and Pro upgrade CTAs (#3112) docs: standardize warning syntax to GFM alert format (#3115) docs: improve react-intl documentation for React Server Components (#3085) Fix generator CI SSR regression on main (#3110) Refocus GitHub README on docs navigation (#3113) Add manual dev environment testing checklist for coding agents (#3074) Bump version to 16.6.0 Update CHANGELOG.md for 16.6.0 (#3078) fix: node-renderer diagnostic improvements (#3086) fix: pin third-party npm deps in generator to prevent peer dep conflicts (#3083) chore(deps): bump lodash from 4.17.23 to 4.18.1 in the npm-security group across 1 directory (#2920) fix: refactor formatExceptionMessage to accept generic request context (#2877) Bump version to 16.6.0.rc.1 Update CHANGELOG.md for 16.6.0.rc.1 (#3079) Update CHANGELOG.md unreleased section (#3077) Fix Content-Length mismatch and null renderingRequest errors in node renderer (#3069) Improve memory debugging docs with simpler heap snapshot approach (#3072) ... # Conflicts: # docs/pro/home-pro.md # docs/pro/react-on-rails-pro.md # docs/sidebars.ts
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.
Summary
> **Warning:**instances to> [!WARNING]GFM alert syntax for consistency with the 30+ GFM alerts already used across docsFiles updated
docs/oss/building-features/testing-configuration.mddocs/oss/deployment/docker-deployment.mddocs/oss/migrating/rsc-troubleshooting.mdCloses #3114
Test plan
🤖 Generated with Claude Code
Note
Low Risk
Low risk: documentation-only formatting changes with no code or behavior impact.
Overview
Updates docs to replace remaining
> **Warning:**blockquotes with GitHub alert callouts (> [!WARNING]) for consistent rendering across the guides, including testing configuration, Kubernetes migration guidance, and RSC troubleshooting.Reviewed by Cursor Bugbot for commit 96c2ae5. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit