Add the contributing section#24
Open
Arctis-Fireblight wants to merge 4 commits into
Open
Conversation
- Increased the size of the nav-bar to accomadate deeper nesting and longer names - Fixed handling of index.md files
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
Comment on lines
+242
to
+250
| ``` | ||
| cd platform/android/java | ||
| # On Windows | ||
| ``` | ||
|
|
||
| .\gradlew clean | ||
| # On Linux and macOS | ||
| ./gradlew clean | ||
|
|
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win
Fix broken code block structure.
The code block starting at Line 242 is malformed. The Windows batch commands at Lines 247-250 appear outside the fenced block and the closing fence is missing or misplaced. Restructure as two separate fenced blocks or one properly fenced block with comments:
-
cd platform/android/java # On Windows .\gradlew clean # On Linux and macOS ./gradlew clean
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>
[warning] 242-242: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
---
[warning] 248-248: Headings must start at the beginning of the line
(MD023, heading-start-left)
</details>
</details>
<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 section has a malformed fenced
code block, with the Windows and Linux/macOS commands sitting outside the
intended fence. Fix the Markdown in the documenting block by making the command
examples in the compiling_for_android content a properly closed fenced block, or
split them into separate fenced blocks if needed, so the shell commands under
the gradlew clean example are consistently enclosed and rendered correctly.
</details>
<!-- cr-indicator-types:potential_issue -->
<!-- cr-comment:v1:0e9c582d3c2199aa83a0c078 -->
<!-- This is an auto-generated comment by CodeRabbit -->
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 title for current docs system.
The file title "Building the manual with Sphinx" and the Docusaurus Tabs/TabItem imports indicate this page describes a Sphinx-based build process. If the current Redot documentation uses a different build system (e.g., Blazor static site), this entire page needs rewriting. Remove the Docusaurus imports and verify/update the build instructions for the actual current system.
🤖 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, The page still references a Sphinx workflow and includes
Docusaurus-only imports, so update this document to match the current docs
stack. Remove the unnecessary Tabs/TabItem imports at the top of
building_the_manual.md, rename the heading from “Building the manual with
Sphinx” to the correct current system title, and rewrite the build steps to
describe the actual Redot documentation build process using the relevant docs
entry points or components instead of Sphinx-specific instructions.
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.
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