Update content#23
Conversation
Refactors formatting to use simplified "Component" tables for better readability. Updates supported operating systems, officially deprecates Windows 7/8/8.1, and removes pre-compiled binaries for 32-bit CPUs. Adjusts GPU and OS compatibility details across platforms for native and web editors.
…d reflect changes to supported platforms like removal of pre-compiled 32-bit binaries.
|
Warning Review limit reached
More reviews will be available in 35 minutes and 31 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughAdds a ChangesDanger Callout Rendering
About Section Documentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 3❌ Failed checks (2 warnings, 1 inconclusive)
✅ Passed checks (2 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 |
There was a problem hiding this comment.
Actionable comments posted: 10
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
Redot-Documentation/docs/About/list_of_features.md (1)
454-455: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove remaining "Redot 3" reference per PR objective
#8.PR objective
#8explicitly removes mentions of Redot 3.x from the feature list, yet line 455 still directs users to "consider Redot 3 instead" for C# on the web platform. Replace or remove this reference.🤖 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 `@Redot-Documentation/docs/About/list_of_features.md` around lines 454 - 455, Remove the remaining Redot 3 reference in the feature list entry about web platform C# support. Update the text in the list_of_features content so it no longer says “consider Redot 3 instead,” keeping the wording aligned with PR objective `#8` and preserving the unsupported-platform message in a neutral form.Redot-Documentation/docs/About/faq.md (1)
256-256: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winUpdate Godot-branded desktop file reference.
The
.desktopfile link still usesorg.godotengine.godot.desktop. Per the retrieved learnings, Godot-branded references should be replaced with Redot equivalents when available.🤖 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 `@Redot-Documentation/docs/About/faq.md` at line 256, Update the desktop file reference in the FAQ so it uses the Redot-branded `.desktop` asset instead of the old Godot one. Locate the markdown link in the FAQ content and replace the `org.godotengine.godot.desktop` target with the corresponding Redot equivalent, keeping the surrounding sentence and link text intact.Source: Learnings
🤖 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 `@Redot-Documentation/docs/About/docs_changelog.md`:
- Line 6: The markdown link text in the changelog contains a trailing space
before the closing bracket, which triggers MD039. Update the link in the
docs_changelog entry so the text in the link is trimmed, and verify the
surrounding markdown still renders correctly with the doc_class_reference
target.
In `@Redot-Documentation/docs/About/faq.md`:
- Line 544: The FAQ entry contains a Godot-branded external link that should not
remain as-is. Update the markdown in the FAQ article to either replace the
godotengine.org reference with a Redot-hosted equivalent or remove the link
while preserving the explanatory text. Use the surrounding FAQ content and the
referenced article text to locate the link and keep the wording aligned with
Redot branding.
- Line 221: Fix the spelling mistake in the FAQ text by changing “lancher” to
“launcher” in the affected documentation sentence. Update the wording in the FAQ
content directly so the description of the planned Redot launcher and project
manager is spelled correctly.
In `@Redot-Documentation/docs/About/list_of_features.md`:
- Line 28: The markdown link text in the feature list has a trailing space,
which triggers linting and affects rendering. Update the link entry in the
list_of_features markdown so the link label uses the existing link target but
removes the extra space inside the brackets; check the Web browsers link markup
and keep the rest of the list unchanged.
In `@Redot-Documentation/docs/About/release_policy.md`:
- Line 32: The release policy table has a spelling error in the date entry;
update the “Redot 26.1” row in the release_policy content so “Feburary” is
corrected to “February.”
- Around line 61-66: Fix the grammar in the release policy upgrade guidance by
correcting the sentence in the paragraph around the “breaking changes” wording
and the recommendation text. In the release_policy.md content, adjust the
phrasing in the section containing “we do our best” and the upgrade
recommendation so it reads naturally, specifically removing the duplicated “keep
avoid” construction and changing “if you are needing new features” to “if you
need new features.”
- Around line 92-103: The compatibility criteria list in release_policy.md uses
inconsistent bullet punctuation, so standardize the entire list to one style.
Update the bullets around the “compatibility-breaking” section and the earlier
list items so they all either end with periods or all omit them, keeping the
existing wording intact and adjusting only the punctuation in the affected list
entries.
In `@Redot-Documentation/docs/About/system_requirements.md`:
- Line 16: The table header text is misspelled as “Requirenment” in the system
requirements tables, and this typo appears in multiple repeated headers
throughout the document. Update each affected table header in the same markdown
section so it consistently reads “Requirement,” keeping the rest of the table
structure unchanged.
In `@Redot-Documentation/Services/DocRendererService.cs`:
- Line 306: The callout renderer is injecting presentation markup via
DocRendererService’s callout output, which should be handled by styling instead.
Remove the hard-coded <br/> from the callout rendering path and keep the spacing
in CSS by updating the callout container styles in wwwroot/app.css so adjacent
callouts are spaced consistently without extra HTML.
In `@Redot-Documentation/wwwroot/app.css`:
- Around line 160-176: The stylesheet has extra blank lines inside rules that
violate Stylelint’s declaration-empty-line-before rule. Update the affected
callout rule blocks in app.css, especially the callout-danger block and the
adjacent callout styles, by removing the empty separator lines between
declarations while keeping the declarations themselves intact so the existing
CSS selectors remain unchanged.
---
Outside diff comments:
In `@Redot-Documentation/docs/About/faq.md`:
- Line 256: Update the desktop file reference in the FAQ so it uses the
Redot-branded `.desktop` asset instead of the old Godot one. Locate the markdown
link in the FAQ content and replace the `org.godotengine.godot.desktop` target
with the corresponding Redot equivalent, keeping the surrounding sentence and
link text intact.
In `@Redot-Documentation/docs/About/list_of_features.md`:
- Around line 454-455: Remove the remaining Redot 3 reference in the feature
list entry about web platform C# support. Update the text in the
list_of_features content so it no longer says “consider Redot 3 instead,”
keeping the wording aligned with PR objective `#8` and preserving the
unsupported-platform message in a neutral form.
🪄 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: 58d834a3-4e05-4563-adb3-fc9c8391ec3b
📒 Files selected for processing (7)
Redot-Documentation/Services/DocRendererService.csRedot-Documentation/docs/About/docs_changelog.mdRedot-Documentation/docs/About/faq.mdRedot-Documentation/docs/About/list_of_features.mdRedot-Documentation/docs/About/release_policy.mdRedot-Documentation/docs/About/system_requirements.mdRedot-Documentation/wwwroot/app.css
| - New features that do not break existing projects. | ||
| - Deprecating a method, member variable, or class. This is done by adding a | ||
| deprecated flag to its class reference, which will show up in the editor. When | ||
| a method is marked as deprecated, it's slated to be removed in the next | ||
| *major* release. | ||
| - Changes that affect the default project theme's visuals. | ||
| - Bug fixes which significantly change the behavior or the output, with the aim | ||
| to meet user expectations better. In comparison, in patch releases, we may | ||
| favor keeping a buggy behavior so we don't break existing projects which | ||
| likely already rely on the bug or use a workaround. | ||
| - Performance optimizations that result in visual changes. | ||
|
|
||
| The following changes are considered **compatibility-breaking** and can only be | ||
| performed in a new major release: | ||
| deprecated flag to its class reference, which will show up in the editor. | ||
|
|
||
| The following changes are considered **compatibility-breaking** and should be avoided: | ||
|
|
||
| - Renaming or removing a method, member variable, or class. | ||
| - Modifying a node's inheritance tree by making it inherit from a different class. | ||
| - Changing the default value of a project setting value in a way that affects existing | ||
| projects. To only affect new projects, the project manager should write a | ||
| modified ``project.Redot`` instead. | ||
|
|
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Standardize list punctuation.
The compatibility criteria bullets use inconsistent terminal punctuation. Lines 85-91 and 92-95 lack periods, while lines 98-102 end with periods. Choose one style for the entire list.
🤖 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 `@Redot-Documentation/docs/About/release_policy.md` around lines 92 - 103, The
compatibility criteria list in release_policy.md uses inconsistent bullet
punctuation, so standardize the entire list to one style. Update the bullets
around the “compatibility-breaking” section and the earlier list items so they
all either end with periods or all omit them, keeping the existing wording
intact and adjusting only the punctuation in the affected list entries.
| </div> | ||
| </div> | ||
| </div> | ||
| <br/> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Keep spacing in CSS instead of emitting a <br/> after every callout.
Line 306 adds presentation markup to every rendered callout, which can create extra vertical gaps between adjacent blocks and makes the HTML output harder to control. This should be a margin on the callout container in Redot-Documentation/wwwroot/app.css, not a hard-coded line break in the renderer.
Suggested change
</div>
- <br/>
""";📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <br/> |
🤖 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 `@Redot-Documentation/Services/DocRendererService.cs` at line 306, The callout
renderer is injecting presentation markup via DocRendererService’s callout
output, which should be handled by styling instead. Remove the hard-coded <br/>
from the callout rendering path and keep the spacing in CSS by updating the
callout container styles in wwwroot/app.css so adjacent callouts are spaced
consistently without extra HTML.
| background: #937a07; | ||
| border-left: 8px solid #756005; | ||
| border-radius: 4px; | ||
| padding: 20px 24px; | ||
| color: white; | ||
| } | ||
|
|
||
| .callout-danger { | ||
| display: flex; | ||
| gap: 16px; | ||
| align-items: flex-start; | ||
|
|
||
| background: #4d0000; | ||
| border-left: 8px solid #8b0000; | ||
| border-radius: 4px; | ||
| padding: 20px 24px; | ||
| color: white; |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Remove the intra-rule blank lines so Stylelint passes.
Stylelint is flagging the empty lines before declarations here (declaration-empty-line-before on Lines 160, 172, 196, 198, and 201), so this change will keep the stylesheet non-compliant until those separators are removed.
Also applies to: 192-202
🧰 Tools
🪛 Stylelint (17.13.0)
[error] 160-160: Expected no empty line before declaration (declaration-empty-line-before)
(declaration-empty-line-before)
[error] 172-172: Expected no empty line before declaration (declaration-empty-line-before)
(declaration-empty-line-before)
🤖 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 `@Redot-Documentation/wwwroot/app.css` around lines 160 - 176, The stylesheet
has extra blank lines inside rules that violate Stylelint’s
declaration-empty-line-before rule. Update the affected callout rule blocks in
app.css, especially the callout-danger block and the adjacent callout styles, by
removing the empty separator lines between declarations while keeping the
declarations themselves intact so the existing CSS selectors remain unchanged.
Source: Linters/SAST tools
…or better readability and accuracy.
A few more misc fixes, and updates to the content of the about section.
Summary by CodeRabbit
New Features
Bug Fixes
Documentation