Add the contributing section#24
Open
Arctis-Fireblight wants to merge 4 commits into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughAdds a Contributing docs section to versioning, adjusts sidebar layout CSS, and adds extensive new contributor documentation across workflows, build guides, IDE setup, core/module references, debugging, editor guidance, and documentation-writing topics. ChangesVersioning and layout wiring
Contributing documentation content
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Note
Due to the large number of review comments, Critical severity comments were prioritized as inline comments.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 383ab185-9a04-4e95-b6cb-cb60f1f067d6
⛔ Files ignored due to path filters (92)
Redot-Documentation/docs/Contributing/Development/core_and_modules/files/class_tree.zipis excluded by!**/*.zipRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/andtemplates.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/encryption_key.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/lintemplates.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_flame_graph.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_record.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_view_results.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_welcome.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_time_profiler.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_time_profiler_record.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_time_profiler_result.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_verysleepy_results_filtered.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_verysleepy_select_process.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_xcode_menu.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices1.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices2.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices3.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices4.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices5.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices6.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices7.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices8.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_setup_project_1.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-add-configuration.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-add-custom-build-application.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-build-run.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-create-clean-tool.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-external-tools.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-preferences.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-run-configuration.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-select-tools.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-target.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_block_use_tab_character.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_add_files_recursively.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_build_targets.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_compiler_and_configuration.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_file_new_project.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_new_empty_project.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_open_build_options.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_open_properties.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_project_properties.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_project_title_and_location.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_scons_clean.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_scons_minimum.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_scons_windows.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_select_files.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_update_editor_settings.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_wizard_welcome.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_addincludes.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_buildconfig.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_configlaunches.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_configlaunches2.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_custombuild.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_newproject.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_openconfig.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-apply-import-filter.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-edit-codestyle.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-edit-files-menu.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-new-project.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-options-cpp.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-project-name-includes.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-projects-build.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-run-command.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-set-project-path.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-set-scons-command.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_1_install_cpp_package.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_2_project_properties.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_4_debugging_main.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_1_create_launch.json.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_2_launch.json.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_3_tasks.json.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_configure_task.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_create_tasksjson.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_create_tasksjson_others.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Node2D.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/architecture_diagram.jpgis excluded by!**/*.jpgRedot-Documentation/wwwroot/img/Contributing/Documentation/editor-vocabulary-overview.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_01_language_list.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_02_new_translation.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_03_translation_overview.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_04_translation_interface.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_05_search_location.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_06_browse_by_location.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_07_download_po_file.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_08_edit_on_github.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_09_path_to_image.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/github_fork_button.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/github_fork_make_pr.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/github_fork_url.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_access_fork.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_fork_zip.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_nightly_link.pngis excluded by!**/*.png
📒 Files selected for processing (107)
Redot-Documentation/Components/Layout/MainLayout.razor.cssRedot-Documentation/Components/Layout/NavMenu.razor.cssRedot-Documentation/Versioning/Section.csRedot-Documentation/Versioning/VersionProvider.csRedot-Documentation/docs/Contributing/Development/best_practices_for_engine_contributors.mdRedot-Documentation/docs/Contributing/Development/code_style_guidelines.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_android.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_ios.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_linuxbsd.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_macos.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_web.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_windows.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_with_dotnet.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_with_script_encryption_key.mdRedot-Documentation/docs/Contributing/Development/compiling/cross-compiling_for_ios_on_linux.mdRedot-Documentation/docs/Contributing/Development/compiling/getting_source.mdRedot-Documentation/docs/Contributing/Development/compiling/introduction_to_the_buildsystem.mdRedot-Documentation/docs/Contributing/Development/compiling/optimizing_for_size.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/android_studio.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/clion.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/code_blocks.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/kdevelop.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/qt_creator.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/rider.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/visual_studio.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/visual_studio_code.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/xcode.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/2d_coordinate_systems.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/binding_to_external_libraries.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/common_engine_methods_and_macros.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/core_types.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_audiostreams.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_godot_servers.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_modules_in_cpp.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_platform_ports.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_resource_format_loaders.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/godot_architecture_diagram.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/inheritance_class_tree.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/internal_rendering_architecture.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/object_class.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/scripting_development.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/unit_testing.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/variant_class.mdRedot-Documentation/docs/Contributing/Development/cpp_usage_guidelines.mdRedot-Documentation/docs/Contributing/Development/debugging/macos_debug.mdRedot-Documentation/docs/Contributing/Development/debugging/using_cpp_profilers.mdRedot-Documentation/docs/Contributing/Development/debugging/using_sanitizers.mdRedot-Documentation/docs/Contributing/Development/debugging/vulkan/vulkan_validation_layers.mdRedot-Documentation/docs/Contributing/Development/editor/creating_icons.mdRedot-Documentation/docs/Contributing/Development/editor/editor_style_guide.mdRedot-Documentation/docs/Contributing/Development/editor/introduction_to_editor_development.mdRedot-Documentation/docs/Contributing/Development/file_formats/gdscript_grammar.mdRedot-Documentation/docs/Contributing/Development/file_formats/tscn.mdRedot-Documentation/docs/Contributing/Development/handling_compatibility_breakages.mdRedot-Documentation/docs/Contributing/Documentation/building_the_manual.mdRedot-Documentation/docs/Contributing/Documentation/class_reference_primer.mdRedot-Documentation/docs/Contributing/Documentation/content_guidelines.mdRedot-Documentation/docs/Contributing/Documentation/contributing_to_the_documentation.mdRedot-Documentation/docs/Contributing/Documentation/docs_image_guidelines.mdRedot-Documentation/docs/Contributing/Documentation/docs_writing_guidelines.mdRedot-Documentation/docs/Contributing/Documentation/editor_and_docs_localization.mdRedot-Documentation/docs/Contributing/Documentation/updating_the_class_reference.mdRedot-Documentation/docs/Contributing/Workflow/bisecting_regressions.mdRedot-Documentation/docs/Contributing/Workflow/bug_triage_guidelines.mdRedot-Documentation/docs/Contributing/Workflow/first_steps.mdRedot-Documentation/docs/Contributing/Workflow/pr_review_guidelines.mdRedot-Documentation/docs/Contributing/Workflow/pr_workflow.mdRedot-Documentation/docs/Contributing/Workflow/testing_pull_requests.mdRedot-Documentation/docs/Contributing/how_to_contribute.mdRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/wintemplates.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_app_build_variant.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_app_configurations_drop_down.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_app_debug_type_setup.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_editor_build_variant.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_editor_configurations_drop_down.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_editor_debug_type_setup.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-create-build-tool.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_attach_to_process.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_attach_to_process_dialog.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_configurations.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_configurations_changed.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_run_debug.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_3_debug_command_line.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_edit_configurations.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_1_create_external_build_project.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_2_set_external_build_project_parameters.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_3_configure_scons.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_4_add_new_target.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_5_select_command_line_target.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_6_after_add_godot_source_to_project.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_7_setup_build_post_action.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_8_setup_run_scheme.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Control.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Node2D.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Node3D.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Object.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/RefCounted.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/rendering_architecture_diagram.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/transforms_overview.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/crop_edit.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/crop_pixels.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/crop_tool.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/cropped_image.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_access_checks.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_checks_artifacts.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_checks_artifacts_list.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_command_line_checkout.webp
| separation. | ||
| - Finally, third-party headers (either from ``thirdparty`` or from the system's | ||
| include paths) come next and should be included with the < and > symbols, e.g. | ||
| `[#include](png.h)`. The block of third-party headers should also be followed |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win
Fix incorrect markdown link for #include <png.h>.
Line 156 shows [#include](png.h) which renders as a hyperlink instead of the intended include directive. This appears to be a conversion artifact where #include <png.h> was incorrectly transformed into a Markdown link.
- `[`#include`](png.h)`. The block of third-party headers should also be followed
+ `#include <png.h>`. The block of third-party headers should also be followedThis occurs in the explanatory text about third-party header includes, so the angle brackets should be preserved as literal text or using </> HTML entities.
📝 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.
Suggested change
| `[#include](png.h)`. The block of third-party headers should also be followed | |
| `#include <png.h>`. The block of third-party headers should also be followed |
🤖 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/Contributing/Development/code_style_guidelines.md`
at line 156, The explanatory text in the third-party headers section has an
incorrect Markdown link for the `#include <png.h>` example, so update that text
to preserve the include directive as literal content instead of a hyperlink. Fix
the sentence in the Markdown content by using the proper `#include <png.h>` form
with escaped angle brackets or HTML entities, and make sure the surrounding
prose still reads naturally.
Source: Learnings
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/Versioning/IRanking.cs`:
- Around line 57-62: The display-name logic in `GetDisplayName()` is stripping
everything after the last dot, which breaks dotted section names coming from
`Section.LoadAndParse()` and `Section.Name`. Update this method to remove only
the `.md` suffix instead of using `LastIndexOf('.')`, so article names still
render cleanly while section names like `4.3` or `foo.bar` remain intact. Keep
the existing underscore-to-space replacement, and ensure the suffix handling is
limited to the file extension case only.
🪄 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: 237285cd-fa16-489e-9b3d-5a35e8338484
📒 Files selected for processing (1)
Redot-Documentation/Versioning/IRanking.cs
Comment on lines
+57
to
+62
| string temp = Name.Replace('_', ' '); | ||
| int extensionLoc = temp.LastIndexOf('.'); | ||
| if (extensionLoc > -1) | ||
| { | ||
| temp = temp.Substring(0, extensionLoc); | ||
| } |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Only strip the .md suffix here.
GetDisplayName() is used for sections too, and Section.LoadAndParse() builds Section.Name from directory names. With the current LastIndexOf('.') logic, any dotted section name gets truncated in the nav (4.3 → 4, foo.bar → foo). Since the upstream caller already limits articles to *.md, this should remove only that suffix, not everything after the last dot.
Suggested fix
- int extensionLoc = temp.LastIndexOf('.');
- if (extensionLoc > -1)
- {
- temp = temp.Substring(0, extensionLoc);
- }
+ if (temp.EndsWith(".md", StringComparison.OrdinalIgnoreCase))
+ {
+ temp = temp[..^3];
+ }📝 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.
Suggested change
| string temp = Name.Replace('_', ' '); | |
| int extensionLoc = temp.LastIndexOf('.'); | |
| if (extensionLoc > -1) | |
| { | |
| temp = temp.Substring(0, extensionLoc); | |
| } | |
| string temp = Name.Replace('_', ' '); | |
| if (temp.EndsWith(".md", StringComparison.OrdinalIgnoreCase)) | |
| { | |
| temp = temp[..^3]; | |
| } |
🤖 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/Versioning/IRanking.cs` around lines 57 - 62, The
display-name logic in `GetDisplayName()` is stripping everything after the last
dot, which breaks dotted section names coming from `Section.LoadAndParse()` and
`Section.Name`. Update this method to remove only the `.md` suffix instead of
using `LastIndexOf('.')`, so article names still render cleanly while section
names like `4.3` or `foo.bar` remain intact. Keep the existing
underscore-to-space replacement, and ensure the suffix handling is limited to
the file extension case only.
- Increased the size of the nav-bar to accomadate deeper nesting and longer names - Fixed handling of index.md files
Arctis-Fireblight
force-pushed
the
contributing
branch
from
9f37425 to
8aad088
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Note
Due to the large number of review comments, Critical severity comments were prioritized as inline comments.
♻️ Duplicate comments (2)
Redot-Documentation/docs/Contributing/Development/code_style_guidelines.md (1)
156-156: 🎯 Functional Correctness | 🔴 Critical | ⚡ Quick winFix incorrect markdown link for
#include <png.h>.Line 156 shows
[#include](png.h)which renders as a hyperlink instead of the intended include directive. Use backticks or HTML entities to preserve the literal syntax:- `[`#include`](png.h)`. The block of third-party headers should also be followed + `#include <png.h>`. The block of third-party headers should also be followed🤖 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/Contributing/Development/code_style_guidelines.md` at line 156, The markdown in the third-party headers section is rendering an include directive as a hyperlink, so update the text around the `#include` example to preserve it as literal syntax rather than a link. Fix the wording in the code_style_guidelines content where `[`#include`](png.h)` appears so it displays as an include statement, using the same surrounding documentation section to locate it.Redot-Documentation/docs/Contributing/Development/compiling/compiling_for_android.md (1)
242-250: 🎯 Functional Correctness | 🔴 Critical | ⚡ Quick winFix broken code block structure.
The fenced code block closes prematurely at line 245, leaving the actual
gradlew cleancommands outside any code block. Restructure as a single fenced block:cd platform/android/java
On Windows
- .\gradlew clean
On Linux and macOS
- ./gradlew clean
- .\gradlew clean
On Linux and macOS
- ./gradlew clean
<details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/compiling/compiling_for_android.md
around lines 242 - 250, The Android compiling doc has a broken fenced code block
in the section with the gradlew clean commands. Fix the markdown structure in
the relevant snippet so thecd platform/android/java,# On Windows,
.\gradlew clean,# On Linux and macOS, and./gradlew cleanlines all
remain inside a single fenced block. Use the nearbygradlew cleanexample and
the surrounding code fence as the reference point when restructuring the
compiling_for_android.mdcontent.</details> <!-- cr-comment:v1:fdb7b16d92804bbb34f6eae3 --> </blockquote></details> </blockquote></details> <details> <summary>🟡 Minor comments (20)</summary><blockquote> <details> <summary>Redot-Documentation/docs/Contributing/Development/compiling/compiling_for_windows.md-360-360 (1)</summary><blockquote> `360-360`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix typo: "buildng" → "building".** <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/compiling/compiling_for_windows.md
at line 360, The contributing guide text contains a typo in the Windows
compiling instructions. Update the sentence in the MinGW build guidance to use
the correct spelling in that paragraph, keeping the rest of the wording
unchanged.</details> <!-- cr-comment:v1:b10d9f0e965ab39be67873a9 --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/class_reference_primer.md-112-113 (1)</summary><blockquote> `112-113`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Replace RST `:ref:` syntax with Markdown links.** `:ref:`compilation guide <toc-devel-compiling>`` is reStructuredText. Convert to a proper Markdown link. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/class_reference_primer.md
around lines 112 - 113, The text in the documentation primer still uses
reStructuredText cross-reference syntax instead of Markdown. Update the affected
sentence in class_reference_primer.md to use a standard Markdown link for the
compilation guide, and keep the surrounding wording intact so the reference
remains readable and consistent with the rest of the file.</details> <!-- cr-comment:v1:e5f554be1052c30f8a9d0411 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/class_reference_primer.md-231-232 (1)</summary><blockquote> `231-232`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix RST-style link syntax.** `experimental code translation tool <https://github.com/HaSa1002/codetranslator>`__` uses RST link syntax with `__` suffix. Convert to standard Markdown `[text](url)`. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/class_reference_primer.md
around lines 231 - 232, Update the documentation link in
class_reference_primer.md to use standard Markdown link syntax instead of the
current RST-style reference. Replace the inlineexperimental code translation toollink in the surrounding documentation text with a normal[text](url)
form, and make sure the visible link text and URL remain unchanged while
removing the trailing RST suffix.</details> <!-- cr-comment:v1:cc01c9c31e2779996c1ef645 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Development/compiling/compiling_for_windows.md-86-86 (1)</summary><blockquote> `86-86`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix bare reference `doc_introduction_to_the_buildsystem_development_and_production_aliases`.** This appears to be an undefined reference without a target path or URL. Add the correct relative link. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/compiling/compiling_for_windows.md
at line 86, The bare reference
doc_introduction_to_the_buildsystem_development_and_production_aliases in the
Windows compiling guide is missing its target, so replace it with the correct
relative link target. Update the relevant markdown in the compiling_for_windows
document so the reference resolves properly and matches the existing
documentation link style.</details> <!-- cr-comment:v1:431a8e488cc7e133cbce6551 --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Development/compiling/compiling_with_dotnet.md-96-96 (1)</summary><blockquote> `96-96`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix malformed link `[--Redot-platform=](platform)`.** The link target `(platform)` appears to be a placeholder or incorrectly migrated from RST. Replace with the correct URL or relative path. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/compiling/compiling_with_dotnet.md
at line 96, The markdown link in the compiling guide is malformed because
[--Redot-platform=](platform)uses a placeholder target instead of a real
destination. Update the documentation text in the affected section to point
--Redot-platform=to the correct relative path or URL, and verify the
surrounding Markdown renders as a proper link using the same
compiling_with_dotnetsection content.</details> <!-- cr-comment:v1:1b68e6ccfc2ca05cb027e8cf --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/class_reference_primer.md-165-166 (1)</summary><blockquote> `165-166`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Remove RST `.. raw:: html` directives from table cells.** These reStructuredText directives won't render in Markdown and will display as literal text. Replace with standard Markdown or HTML if needed. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/class_reference_primer.md
around lines 165 - 166, The table entries in class_reference_primer.md still use
reStructuredText.. raw:: htmldirectives, which will show up as literal text
in Markdown. Update the affected rows in the documentation table to use plain
Markdown or inline HTML directly for the underline and strikethrough examples,
keeping the content in the same table cells and removing the RST directive
syntax.</details> <!-- cr-comment:v1:4fda7d6f367ac927eb502e11 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/building_the_manual.md-136-136 (1)</summary><blockquote> `136-136`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix RST-style reference `doc_building_the_manual:performance`.** The colon-separated reference syntax is RST/Docusaurus, not standard Markdown. Replace with a proper relative link or remove if not applicable to current build system. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/building_the_manual.md
at line 136, The documentation link in building_the_manual.md uses an
RST/Docusaurus-style colon reference that is not valid standard Markdown. Update
the reference in the manual to use a proper relative Markdown link, or remove it
if the target section is not part of the current docs build; use the existing
link text around doc_building_the_manual:performance to locate and replace it.</details> <!-- cr-comment:v1:703aa06c0e7e83cf930f6601 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/class_reference_primer.md-255-280 (1)</summary><blockquote> `255-280`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Remove or replace Docusaurus `Tabs`/`TabItem` components.** These JSX components won't render in the current Blazor docs system. Replace with standard Markdown or remove the tabbed interface. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/class_reference_primer.md
around lines 255 - 280, The example in the class reference primer uses
Docusaurus-only Tabs/TabItem JSX that the Blazor docs renderer cannot display.
Update the example near the GDScript and Csharp snippets to use plain Markdown
instead of the Tabs wrapper, or remove the tabbed layout entirely while keeping
the code samples readable. Make sure the content remains in the same section and
is still easy to compare between the two languages.</details> <!-- cr-comment:v1:b279573c9caf8389186854c7 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/building_the_manual.md-96-104 (1)</summary><blockquote> `96-104`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix directory name mismatch in clone/cd instructions.** Line 96 clones `redot-docs-site.git` but line 104 tries to `cd Redot-docs`. The directory names don't match; use the correct repository name. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/building_the_manual.md
around lines 96 - 104, The clone and cd instructions use different repository
names, so update the documentation snippet to use the same directory name in
both places. In the build manual section, align thegit clonetarget with the
cdcommand so readers can enter the cloned docs repository without hitting a
path mismatch.</details> <!-- cr-comment:v1:1111b0dc98bc3598840b562c --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/building_the_manual.md-20-20 (1)</summary><blockquote> `20-20`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix RST-style link syntax.** The `` `...`__ `` syntax is reStructuredText, not Markdown. Convert to standard Markdown `[text](url)` format. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/building_the_manual.md
at line 20, The documentation currently uses reStructuredText link syntax
instead of Markdown. Update the link in the manual’s contributing guide to
standard Markdown format, replacing the...__ style with a[text](url)link
so it renders correctly in Markdown. Use the existing pip installation URL in
the affected paragraph and keep the surrounding wording unchanged.</details> <!-- cr-comment:v1:31e9c942e8942aa7afc278e9 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/class_reference_primer.md-84-85 (1)</summary><blockquote> `84-85`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Replace RST `:ref:` syntax with Markdown links.** `:ref:`writing guidelines <doc_docs_writing_guidelines>`` is reStructuredText, not Markdown. Convert to `[writing guidelines](doc_docs_writing_guidelines.md)` or appropriate relative path. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/class_reference_primer.md
around lines 84 - 85, The wording in this documentation still uses RST-style
:ref: syntax, which is inconsistent with the Markdown format used here. Update
the referenced text in the class_reference_primer.md content to use a Markdown
link instead, and make sure the link target matches the documentation file or
relative path for the writing guidelines. Keep the surrounding sentence short
and clear while preserving the existing reference to the writing guidelines.</details> <!-- cr-comment:v1:527db9b1ddea167f21080f16 --> _Source: Learnings_ </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Development/compiling/compiling_for_web.md-90-90 (1)</summary><blockquote> `90-90`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix broken link reference `doc_javascript_export_options`.** This reference has no target URL or path. Add the correct relative path or full URL. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/compiling/compiling_for_web.md
at line 90, The link reference doc_javascript_export_options is broken because
it has no resolved target. Update the markdown in the compiling_for_web docs to
point the “export page” link to the correct relative documentation path or full
URL, using the existing link text and ensuring the target matches the actual
export options page.</details> <!-- cr-comment:v1:95f650d754eaab949841a26b --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Development/compiling/compiling_for_web.md-128-128 (1)</summary><blockquote> `128-128`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix broken link reference `doc_javascript_export_options`.** Same undefined reference as line 90. Add the correct target path or URL. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/compiling/compiling_for_web.md
at line 128, The web compiling doc contains a broken link reference to
doc_javascript_export_options, so update the markdown link target to the correct
existing export page path or URL. Locate the reference in the compiling_for_web
content and replace the undefined target with the proper identifier used by the
documentation system so the link resolves consistently with the earlier
occurrence.</details> <!-- cr-comment:v1:932a35b4928ea76a3d417eac --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Development/file_formats/tscn.md-245-245 (1)</summary><blockquote> `245-245`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix bare reference `doc_tscn_animation`.** This reference has no target path or URL. Add the correct relative link to the animation documentation. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Development/file_formats/tscn.mdat
line 245, Thedoc_tscn_animationreference in the TSCN documentation is a bare
link target with no actual path, so update that markdown reference to point to
the correct relative animation documentation location. Locate thedocumented [here](doc_tscn_animation)text in thetscndocs and replace it with the
proper relative link used for the animation docs so the reference resolves
correctly.</details> <!-- cr-comment:v1:991067323a6a5dad277684d0 --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/docs_image_guidelines.md-23-23 (1)</summary><blockquote> `23-23`: _📐 Maintainability & Code Quality_ | _🟡 Minor_ | _⚡ Quick win_ **Fix grammar: "it's" → "its".** Line 23: "Each Linux desktop environment has **it's** own screenshot tool" — the possessive form is **its** (no apostrophe). <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/docs_image_guidelines.md
at line 23, Fix the grammar in the documentation sentence by changing the
possessive form from “it’s” to “its” in the screenshot-tools example; update the
wording in the docs section containing the “Each Linux desktop environment…”
sentence so it uses the correct possessive form and keeps the rest of the text
unchanged.</details> <!-- cr-comment:v1:e9c947b08788cabcc7bbda3f --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/docs_image_guidelines.md-107-107 (1)</summary><blockquote> `107-107`: _📐 Maintainability & Code Quality_ | _🟡 Minor_ | _⚡ Quick win_ **Fix grammar: "popup" → "pop up".** Line 107: "a menu will **popup**" — as a verb, this should be two words: **pop up**. <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/docs_image_guidelines.md
at line 107, Update the wording in the documentation sentence that uses “popup”
so it reads “pop up” instead. Locate the affected text in the documentation
section about webp options and adjust the sentence around that phrase to use the
correct verb form while keeping the rest of the instruction unchanged.</details> <!-- cr-comment:v1:a6d559fd75d4ce986474159d --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Documentation/docs_image_guidelines.md-128-128 (1)</summary><blockquote> `128-128`: _📐 Maintainability & Code Quality_ | _🟡 Minor_ | _⚡ Quick win_ **Add hyphens to compound adjectives.** Lines 128 and 134: "color blind" and "non fancy" should be hyphenated as **color-blind** and **non-fancy** when used as compound adjectives before nouns. Also applies to: 134-134 <details> <summary>🤖 Prompt for AI Agents</summary>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/Contributing/Documentation/docs_image_guidelines.md
at line 128, The documentation text uses unhyphenated compound adjectives, so
update the wording in the relevant paragraph(s) to use color-blind and non-fancy
when they modify nouns. Keep the same meaning, but make sure the phrasing in the
documentation content is consistently hyphenated wherever those adjectives
appear.</details> <!-- cr-comment:v1:a8499b587355f98d20795708 --> </blockquote></details> <details> <summary>Redot-Documentation/docs/Contributing/Development/configuring_an_ide/xcode.md-53-54 (1)</summary><blockquote> `53-54`: _🎯 Functional Correctness_ | _🟡 Minor_ | _⚡ Quick win_ **Fix typo: "two two asterisks" → "two asterisks".** ```diff - include subdirectories as well. To achieve that, add two two asterisks (``**``) to the + include subdirectories as well. To achieve that, add two asterisks (``**``) to the🤖 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/Contributing/Development/configuring_an_ide/xcode.md` around lines 53 - 54, Fix the typo in the Xcode IDE configuration documentation: the sentence in the contributing guide currently says “add two two asterisks” and should be corrected to “add two asterisks.” Update the wording in the affected markdown section so the example path explanation reads cleanly and consistently.Redot-Documentation/docs/Contributing/Development/core_and_modules/2d_coordinate_systems.md-9-10 (1)
9-10: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winFix grammar: "to an other" → "to another".
- system to an other. In order to use them, it is beneficial to know which coordinate + system to another. In order to use them, it is beneficial to know which coordinate🤖 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/Contributing/Development/core_and_modules/2d_coordinate_systems.md` around lines 9 - 10, The sentence in the 2D coordinate systems documentation has a grammar error (“to an other” should be “to another”); update the wording in the introductory paragraph near the [Transform2D] explanation so the sentence reads naturally and correctly.Source: Linters/SAST tools
Redot-Documentation/docs/Contributing/Development/core_and_modules/custom_platform_ports.md-182-182 (1)
182-182: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFix broken Markdown link/code syntax.
[scons platform=](name)is malformed Markdown. It appears to be trying to show a command with a placeholder. Use inline code instead:-then run `[scons platform=](name)`. No other steps are +then run `scons platform=<name>`. No other steps are🤖 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/Contributing/Development/core_and_modules/custom_platform_ports.md` at line 182, The Markdown in the custom platform ports guide has a malformed link-like token in the sentence about running the SCons command. Update the text around the platform build instruction to use inline code for the command placeholder instead of a broken link syntax, and keep the surrounding wording in the same section of the documentation consistent with the existing style.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: be58c212-aaaa-4259-9954-306cde8b7b7d
⛔ Files ignored due to path filters (92)
Redot-Documentation/docs/Contributing/Development/core_and_modules/files/class_tree.zipis excluded by!**/*.zipRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/andtemplates.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/encryption_key.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/lintemplates.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_flame_graph.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_record.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_view_results.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_hotspot_welcome.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_time_profiler.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_time_profiler_record.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_time_profiler_result.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_verysleepy_results_filtered.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_verysleepy_select_process.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/Debugging/cpp_profiler_xcode_menu.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices1.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices2.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices3.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices4.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices5.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices6.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices7.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/best_practices8.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_setup_project_1.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-add-configuration.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-add-custom-build-application.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-build-run.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-create-clean-tool.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-external-tools.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-preferences.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-run-configuration.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-select-tools.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-target.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_block_use_tab_character.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_add_files_recursively.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_build_targets.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_compiler_and_configuration.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_file_new_project.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_new_empty_project.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_open_build_options.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_open_properties.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_project_properties.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_project_title_and_location.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_scons_clean.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_scons_minimum.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_scons_windows.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_select_files.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_update_editor_settings.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/code_blocks_wizard_welcome.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_addincludes.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_buildconfig.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_configlaunches.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_configlaunches2.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_custombuild.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_newproject.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/kdevelop_openconfig.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-apply-import-filter.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-edit-codestyle.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-edit-files-menu.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-new-project.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-options-cpp.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-project-name-includes.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-projects-build.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-run-command.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-set-project-path.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/qtcreator-set-scons-command.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_1_install_cpp_package.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_2_project_properties.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_4_debugging_main.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_1_create_launch.json.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_2_launch.json.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_3_tasks.json.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_configure_task.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_create_tasksjson.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_create_tasksjson_others.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Node2D.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/architecture_diagram.jpgis excluded by!**/*.jpgRedot-Documentation/wwwroot/img/Contributing/Documentation/editor-vocabulary-overview.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_01_language_list.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_02_new_translation.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_03_translation_overview.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_04_translation_interface.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_05_search_location.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_06_browse_by_location.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_07_download_po_file.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_08_edit_on_github.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Documentation/l10n_09_path_to_image.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/github_fork_button.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/github_fork_make_pr.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/github_fork_url.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_access_fork.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_fork_zip.pngis excluded by!**/*.pngRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_nightly_link.pngis excluded by!**/*.png
📒 Files selected for processing (108)
Redot-Documentation/Components/Layout/MainLayout.razor.cssRedot-Documentation/Components/Layout/NavMenu.razor.cssRedot-Documentation/Versioning/IRanking.csRedot-Documentation/Versioning/Section.csRedot-Documentation/Versioning/VersionProvider.csRedot-Documentation/docs/Contributing/Development/best_practices_for_engine_contributors.mdRedot-Documentation/docs/Contributing/Development/code_style_guidelines.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_android.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_ios.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_linuxbsd.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_macos.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_web.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_for_windows.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_with_dotnet.mdRedot-Documentation/docs/Contributing/Development/compiling/compiling_with_script_encryption_key.mdRedot-Documentation/docs/Contributing/Development/compiling/cross-compiling_for_ios_on_linux.mdRedot-Documentation/docs/Contributing/Development/compiling/getting_source.mdRedot-Documentation/docs/Contributing/Development/compiling/introduction_to_the_buildsystem.mdRedot-Documentation/docs/Contributing/Development/compiling/optimizing_for_size.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/android_studio.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/clion.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/code_blocks.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/kdevelop.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/qt_creator.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/rider.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/visual_studio.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/visual_studio_code.mdRedot-Documentation/docs/Contributing/Development/configuring_an_ide/xcode.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/2d_coordinate_systems.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/binding_to_external_libraries.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/common_engine_methods_and_macros.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/core_types.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_audiostreams.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_godot_servers.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_modules_in_cpp.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_platform_ports.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/custom_resource_format_loaders.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/godot_architecture_diagram.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/inheritance_class_tree.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/internal_rendering_architecture.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/object_class.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/scripting_development.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/unit_testing.mdRedot-Documentation/docs/Contributing/Development/core_and_modules/variant_class.mdRedot-Documentation/docs/Contributing/Development/cpp_usage_guidelines.mdRedot-Documentation/docs/Contributing/Development/debugging/macos_debug.mdRedot-Documentation/docs/Contributing/Development/debugging/using_cpp_profilers.mdRedot-Documentation/docs/Contributing/Development/debugging/using_sanitizers.mdRedot-Documentation/docs/Contributing/Development/debugging/vulkan/vulkan_validation_layers.mdRedot-Documentation/docs/Contributing/Development/editor/creating_icons.mdRedot-Documentation/docs/Contributing/Development/editor/editor_style_guide.mdRedot-Documentation/docs/Contributing/Development/editor/introduction_to_editor_development.mdRedot-Documentation/docs/Contributing/Development/file_formats/gdscript_grammar.mdRedot-Documentation/docs/Contributing/Development/file_formats/tscn.mdRedot-Documentation/docs/Contributing/Development/handling_compatibility_breakages.mdRedot-Documentation/docs/Contributing/Documentation/building_the_manual.mdRedot-Documentation/docs/Contributing/Documentation/class_reference_primer.mdRedot-Documentation/docs/Contributing/Documentation/content_guidelines.mdRedot-Documentation/docs/Contributing/Documentation/contributing_to_the_documentation.mdRedot-Documentation/docs/Contributing/Documentation/docs_image_guidelines.mdRedot-Documentation/docs/Contributing/Documentation/docs_writing_guidelines.mdRedot-Documentation/docs/Contributing/Documentation/editor_and_docs_localization.mdRedot-Documentation/docs/Contributing/Documentation/updating_the_class_reference.mdRedot-Documentation/docs/Contributing/Workflow/bisecting_regressions.mdRedot-Documentation/docs/Contributing/Workflow/bug_triage_guidelines.mdRedot-Documentation/docs/Contributing/Workflow/first_steps.mdRedot-Documentation/docs/Contributing/Workflow/pr_review_guidelines.mdRedot-Documentation/docs/Contributing/Workflow/pr_workflow.mdRedot-Documentation/docs/Contributing/Workflow/testing_pull_requests.mdRedot-Documentation/docs/Contributing/how_to_contribute.mdRedot-Documentation/wwwroot/img/Contributing/Development/Compiling/wintemplates.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_app_build_variant.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_app_configurations_drop_down.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_app_debug_type_setup.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_editor_build_variant.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_editor_configurations_drop_down.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/android_studio_editor_debug_type_setup.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/clion-create-build-tool.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_attach_to_process.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_attach_to_process_dialog.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_configurations.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_configurations_changed.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/rider_run_debug.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vs_3_debug_command_line.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/vscode_edit_configurations.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_1_create_external_build_project.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_2_set_external_build_project_parameters.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_3_configure_scons.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_4_add_new_target.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_5_select_command_line_target.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_6_after_add_godot_source_to_project.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_7_setup_build_post_action.webpRedot-Documentation/wwwroot/img/Contributing/Development/configuring_an_ide/xcode_8_setup_run_scheme.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Control.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Node2D.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Node3D.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/Object.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/RefCounted.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/rendering_architecture_diagram.webpRedot-Documentation/wwwroot/img/Contributing/Development/core_and_modules/transforms_overview.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/crop_edit.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/crop_pixels.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/crop_tool.webpRedot-Documentation/wwwroot/img/Contributing/Documentation/cropped_image.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_access_checks.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_checks_artifacts.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_checks_artifacts_list.webpRedot-Documentation/wwwroot/img/Contributing/Workflow/testing_pull_requests_command_line_checkout.webp
✅ Files skipped from review due to trivial changes (6)
- Redot-Documentation/docs/Contributing/Documentation/editor_and_docs_localization.md
- Redot-Documentation/docs/Contributing/Development/core_and_modules/godot_architecture_diagram.md
- Redot-Documentation/docs/Contributing/Development/core_and_modules/inheritance_class_tree.md
- Redot-Documentation/docs/Contributing/Development/file_formats/gdscript_grammar.md
- Redot-Documentation/docs/Contributing/Development/handling_compatibility_breakages.md
- Redot-Documentation/docs/Contributing/Development/core_and_modules/common_engine_methods_and_macros.md
🚧 Files skipped from review as they are similar to previous changes (6)
- Redot-Documentation/Components/Layout/MainLayout.razor.css
- Redot-Documentation/Versioning/IRanking.cs
- Redot-Documentation/docs/Contributing/Development/cpp_usage_guidelines.md
- Redot-Documentation/Versioning/VersionProvider.cs
- Redot-Documentation/Versioning/Section.cs
- Redot-Documentation/docs/Contributing/Development/debugging/using_sanitizers.md
Comment on lines
+199
to
+207
| file->close(); | ||
|
|
||
| String error_string; | ||
| int error_line; | ||
| JSON json; | ||
| Variant result; | ||
| error = json.parse(json_string, result, error_string, error_line); | ||
| if (error != OK) { | ||
| file->close(); |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win
Fix double-close bug in load_file example.
At line 199, file->close() is called before JSON parsing. The error path at line 207 then calls file->close() again on an already-closed handle. Remove the redundant close or restructure to keep the file open until parsing succeeds.
String json_string = String("");
while (!file->eof_reached()) {
json_string += file->get_line();
}
- file->close();
String error_string;
int error_line;
JSON json;
Variant result;
error = json.parse(json_string, result, error_string, error_line);
if (error != OK) {
- file->close();
return error;
}
content = Dictionary(result);
+ file->close();
return OK;📝 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.
Suggested change
| file->close(); | |
| String error_string; | |
| int error_line; | |
| JSON json; | |
| Variant result; | |
| error = json.parse(json_string, result, error_string, error_line); | |
| if (error != OK) { | |
| file->close(); | |
| String error_string; | |
| int error_line; | |
| JSON json; | |
| Variant result; | |
| error = json.parse(json_string, result, error_string, error_line); | |
| if (error != OK) { | |
| return error; | |
| } | |
| content = Dictionary(result); | |
| file->close(); |
🤖 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/Contributing/Development/core_and_modules/custom_resource_format_loaders.md`
around lines 199 - 207, The load_file example has a double-close issue around
the JSON parsing flow: the file is closed before calling JSON::parse and then
closed again in the error branch. Update load_file so FileAccess is only closed
once by either removing the early file->close() or moving cleanup to a single
exit path after parsing; keep the logic around json.parse, error, and the file
handle consistent.
Comment on lines
+1
to
+2
| import Tabs from "@theme/Tabs"; | ||
| import TabItem from "@theme/TabItem"; |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🔴 Critical | 🏗️ Heavy lift
Replace Docusaurus JSX tabs with Blazor-compatible syntax.
Lines 1–2 and 63–125 use Docusaurus-specific React components (import Tabs, import TabItem, <Tabs>, <TabItem>) that won't render in Blazor. Replace with Blazor tab components or plain Markdown sections with headers.
Based on learnings, expect artifacts from prior doc migrations (Sphinx RST → Docusaurus MDX → custom Blazor). Remove or correct such leftovers so the rendered output matches the current Blazor docs requirements.
Also applies to: 63-125
🤖 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/Contributing/Development/debugging/vulkan/vulkan_validation_layers.md`
around lines 1 - 2, Remove the Docusaurus-only Tabs/TabItem usage from this
document and replace it with Blazor-compatible tab markup or plain Markdown
sections. Update the top-level imports and the tabbed content block in the
validation layers guide so no React/MDX leftovers remain, and verify the section
renders correctly under the current Blazor docs system using the document’s
tabbed-content area.
Source: Learnings
Comment on lines
+1
to
+8
| import Tabs from "@theme/Tabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| # Building the manual with Sphinx | ||
|
|
||
| This page explains how to build a local copy of the Redot manual using the | ||
| Sphinx docs engine. This allows you to have local HTML files and build the | ||
| documentation as a PDF, EPUB, or LaTeX file, for example. |
Contributor
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🔴 Critical | 🏗️ Heavy lift
Remove Docusaurus imports and update for current docs build system.
The Docusaurus Tabs/TabItem imports and "Building the manual with Sphinx" title indicate this page is unmigrated from prior tooling. Per prior review, remove these imports and rewrite build instructions for the actual current system (Blazor). The Sphinx-specific commands (make html, sphinx-build) and RST-style references will not work for contributors.
🤖 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/Contributing/Documentation/building_the_manual.md`
around lines 1 - 8, This page is still using legacy Docusaurus/Sphinx content,
so update the documentation to match the current Blazor-based build flow. Remove
the unused Tabs and TabItem imports from the doc, replace the “Building the
manual with Sphinx” wording, and rewrite the build steps in the manual content
to use the current docs tooling and commands instead of Sphinx-specific ones.
Make sure the updated instructions align with the existing documentation
structure and reference the current build process used by the docs site.
Source: Learnings
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 by CodeRabbit