Skip to content

Migrate contributing contents to a separate documentation site. #11188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2025
Merged

Migrate contributing contents to a separate documentation site. #11188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ assignees: ''

If you know how to fix the issue you are reporting please
consider opening a pull request. We provide a tutorial on
using git here: https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.godotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.godotengine.org/en/stable/community/contributing/updating_the_class_reference.html
using git here: https://contributing.godotengine.org/en/latest/organization/pull_requests/creating_pull_requests.html,
writing documentation at https://contributing.godotengine.org/en/latest/documentation/guidelines/index.html
and contributing to the class reference here: https://contributing.godotengine.org/en/latest/documentation/class_reference.html
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ repos:
rev: v2.3.0
hooks:
- id: codespell
files: ^(about|community|contributing|getting_started|tutorials)/.*\.rst$
files: ^(about|community|engine_details|getting_started|tutorials)/.*\.rst$
additional_dependencies: [tomli]

- repo: https://github.com/pre-commit/pre-commit-hooks
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Here are some quick links to the areas you might be interested in:
3. [Content guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/content_guidelines.html)
4. [Writing guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html)
5. [Building the manual](https://docs.godotengine.org/en/latest/contributing/documentation/building_the_manual.html)
6. [Translating the documentation](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)
6. [Translating the documentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html)

## License

Expand Down
6 changes: 3 additions & 3 deletions _styleguides/de.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lesbarkeit, Klarheit und Benutzbarkeit besonders im Vordergrund stehen.

Für die Übersetzung selbst ist das Tool
[Weblate](https://hosted.weblate.org/projects/godot-engine/) im Einsatz, das in der
[offiziellen Dokumentation](https://docs.godotengine.org/de/4.x/contributing/documentation/editor_and_docs_localization.html) näher
[offiziellen Dokumentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html) näher
erläutert wird. Die Bedienung von Weblate ist nicht Bestandteil dieses
Dokuments.

Expand Down Expand Up @@ -357,8 +357,8 @@ mit übersetzt werden sollten.

Für Übersetzungen des Editors und der Properties ist es ratsam, diese
auch selbst zu testen, indem
man [die aktuelle Übersetzung herunterlädt](https://docs.godotengine.org/de/4.x/contributing/documentation/editor_and_docs_localization.html#offline-translation-and-testing)
und Godot mit den Änderungen [selbst kompiliert](https://docs.godotengine.org/de/4.x/contributing/development/compiling/compiling_for_windows.html).
man [die aktuelle Übersetzung herunterlädt](https://contributing.godotengine.org/en/latest/documentation/translation/index.html#offline-translation-and-testing)
und Godot mit den Änderungen [selbst kompiliert](https://docs.godotengine.org/de/4.x/engine_details/development/compiling/compiling_for_windows.html).

Gerade bei der Anleitung kommt es oft auf den Kontext zwischen benachbarten
Textblöcken an, sodass das Lesen eines ganzen Artikels Fehler sichtbar
Expand Down
2 changes: 1 addition & 1 deletion _templates/breadcrumbs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
}
}
</style>
<a class="godot-edit-guidelines" href="https://docs.godotengine.org/en/latest/contributing/documentation/index.html#writing-documentation">
<a class="godot-edit-guidelines" href="https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html">
Learn how to contribute!
</a>
</li>
Expand Down
117 changes: 48 additions & 69 deletions _tools/redirects/redirects.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,84 +2,63 @@ source,destination
/about/index.html,/index.html
/about/troubleshooting.html,/tutorials/troubleshooting.html
/classes/_classes.html,/classes/
/community/contributing/best_practices_for_engine_contributors.html,/contributing/development/best_practices_for_engine_contributors.html
/community/contributing/bisecting_regressions.html,/contributing/workflow/bisecting_regressions.html
/community/contributing/bug_triage_guidelines.html,/contributing/workflow/bug_triage_guidelines.html
/community/contributing/building_the_manual.html,/contributing/documentation/building_the_manual.html
/community/contributing/class_reference_writing_guidelines.html,/contributing/documentation/class_reference_primer.html
/community/contributing/code_style_guidelines.html,/contributing/development/code_style_guidelines.html
/community/contributing/content_guidelines.html,/contributing/documentation/content_guidelines.html
/community/contributing/contributing_to_the_documentation.html,/contributing/documentation/contributing_to_the_documentation.html
/community/contributing/cpp_usage_guidelines.html,/contributing/development/cpp_usage_guidelines.html
/community/contributing/docs_writing_guidelines.html,/contributing/documentation/docs_writing_guidelines.html
/community/contributing/editor_and_docs_localization.html,/contributing/documentation/editor_and_docs_localization.html
/community/contributing/index.html,/contributing/ways_to_contribute.html
/community/contributing/pr_workflow.html,/contributing/workflow/pr_workflow.html
/community/contributing/testing_pull_requests.html,/contributing/workflow/testing_pull_requests.html
/community/contributing/updating_the_class_reference.html,/contributing/documentation/updating_the_class_reference.html
/community/contributing/ways_to_contribute.html,/contributing/ways_to_contribute.html
/community/tutorials/3d/mesh_generation_with_heightmap_and_shaders.html,/tutorials/3d/mesh_generation_with_heightmap_and_shaders.html
/community/tutorials/gdnative/gdnative-c-example.html,/tutorials/plugins/gdnative/gdnative-c-example.html
/community/tutorials/gdnative/index.html,/tutorials/plugins/gdnative/index.html
/community/tutorials/vr/index.html,/tutorials/vr/index.html
/community/tutorials/vr/vr_primer.html,/tutorials/vr/vr_primer.html
/content/3d/making_trees.html,/tutorials/content/making_trees.html
/contributing/_contributing.html,/community/contributing/
/contributing/bug_triage_guidelines.html,/community/contributing/bug_triage_guidelines.html
/contributing/development/compiling/compiling_with_mono.html,/contributing/development/compiling/compiling_with_dotnet.html
/contributing/development/core_and_modules/introduction_to_godot_development.html,/contributing/development/core_and_modules/index.html
/contributing/doc_and_l10n_guidelines.html,/community/contributing/doc_and_l10n_guidelines.html
/contributing/updating_the_class_reference.html,/community/contributing/updating_the_class_reference.html
/contributing/ways_to_contribute.html,/contributing/how_to_contribute.html
/development/compiling/compiling_for_android.html,/contributing/development/compiling/compiling_for_android.html
/development/compiling/compiling_for_ios.html,/contributing/development/compiling/compiling_for_ios.html
/development/compiling/compiling_for_linuxbsd.html,/contributing/development/compiling/compiling_for_linuxbsd.html
/development/compiling/compiling_for_macos.html,/contributing/development/compiling/compiling_for_macos.html
/development/compiling/compiling_for_uwp.html,/contributing/development/compiling/compiling_for_uwp.html
/development/compiling/compiling_for_web.html,/contributing/development/compiling/compiling_for_web.html
/development/compiling/compiling_for_windows.html,/contributing/development/compiling/compiling_for_windows.html
/development/compiling/compiling_for_x11.html,/contributing/development/compiling/compiling_for_linuxbsd.html
/development/compiling/compiling_with_mono.html,/contributing/development/compiling/compiling_with_mono.html
/development/compiling/compiling_with_script_encryption_key.html,/contributing/development/compiling/compiling_with_script_encryption_key.html
/development/compiling/cross-compiling_for_ios_on_linux.html,/contributing/development/compiling/cross-compiling_for_ios_on_linux.html
/development/compiling/getting_source.html,/contributing/development/compiling/getting_source.html
/development/compiling/index.html,/contributing/development/compiling/index.html
/development/compiling/introduction_to_the_buildsystem.html,/contributing/development/compiling/introduction_to_the_buildsystem.html
/development/compiling/optimizing_for_size.html,/contributing/development/compiling/optimizing_for_size.html
/contributing/development/compiling/compiling_with_mono.html,/engine_details/development/compiling/compiling_with_dotnet.html
/contributing/development/core_and_modules/introduction_to_godot_development.html,/engine_details/development/core_and_modules/index.html
/development/compiling/compiling_for_android.html,/engine_details/development/compiling/compiling_for_android.html
/development/compiling/compiling_for_ios.html,/engine_details/development/compiling/compiling_for_ios.html
/development/compiling/compiling_for_linuxbsd.html,/engine_details/development/compiling/compiling_for_linuxbsd.html
/development/compiling/compiling_for_macos.html,/engine_details/development/compiling/compiling_for_macos.html
/development/compiling/compiling_for_uwp.html,/engine_details/development/compiling/compiling_for_uwp.html
/development/compiling/compiling_for_web.html,/engine_details/development/compiling/compiling_for_web.html
/development/compiling/compiling_for_windows.html,/engine_details/development/compiling/compiling_for_windows.html
/development/compiling/compiling_for_x11.html,/engine_details/development/compiling/compiling_for_linuxbsd.html
/development/compiling/compiling_with_mono.html,/engine_details/development/compiling/compiling_with_mono.html
/development/compiling/compiling_with_script_encryption_key.html,/engine_details/development/compiling/compiling_with_script_encryption_key.html
/development/compiling/cross-compiling_for_ios_on_linux.html,/engine_details/development/compiling/cross-compiling_for_ios_on_linux.html
/development/compiling/getting_source.html,/engine_details/development/compiling/getting_source.html
/development/compiling/index.html,/engine_details/development/compiling/index.html
/development/compiling/introduction_to_the_buildsystem.html,/engine_details/development/compiling/introduction_to_the_buildsystem.html
/development/compiling/optimizing_for_size.html,/engine_details/development/compiling/optimizing_for_size.html
/development/consoles/consoles.html,/tutorials/platform/consoles.html
/development/cpp/binding_to_external_libraries.html,/contributing/development/core_and_modules/binding_to_external_libraries.html
/development/cpp/common_engine_methods_and_macros.html,/contributing/development/core_and_modules/common_engine_methods_and_macros.html
/development/cpp/configuring_an_ide/android_studio.html,/contributing/development/configuring_an_ide/android_studio.html
/development/cpp/configuring_an_ide/clion.html,/contributing/development/configuring_an_ide/clion.html
/development/cpp/configuring_an_ide/code_blocks.html,/contributing/development/configuring_an_ide/code_blocks.html
/development/cpp/configuring_an_ide/index.html,/contributing/development/configuring_an_ide/index.html
/development/cpp/configuring_an_ide/kdevelop.html,/contributing/development/configuring_an_ide/kdevelop.html
/development/cpp/configuring_an_ide/qt_creator.html,/contributing/development/configuring_an_ide/qt_creator.html
/development/cpp/configuring_an_ide/visual_studio.html,/contributing/development/configuring_an_ide/visual_studio.html
/development/cpp/configuring_an_ide/visual_studio_code.html,/contributing/development/configuring_an_ide/visual_studio_code.html
/development/cpp/configuring_an_ide/xcode.html,/contributing/development/configuring_an_ide/xcode.html
/development/cpp/core_types.html,/contributing/development/core_and_modules/core_types.html
/development/cpp/custom_audiostreams.html,/contributing/development/core_and_modules/custom_audiostreams.html
/development/cpp/custom_godot_servers.html,/contributing/development/core_and_modules/custom_godot_servers.html
/development/cpp/custom_modules_in_cpp.html,/contributing/development/core_and_modules/custom_modules_in_cpp.html
/development/cpp/binding_to_external_libraries.html,/engine_details/development/core_and_modules/binding_to_external_libraries.html
/development/cpp/common_engine_methods_and_macros.html,/engine_details/development/core_and_modules/common_engine_methods_and_macros.html
/development/cpp/configuring_an_ide/android_studio.html,/engine_details/development/configuring_an_ide/android_studio.html
/development/cpp/configuring_an_ide/clion.html,/engine_details/development/configuring_an_ide/clion.html
/development/cpp/configuring_an_ide/code_blocks.html,/engine_details/development/configuring_an_ide/code_blocks.html
/development/cpp/configuring_an_ide/index.html,/engine_details/development/configuring_an_ide/index.html
/development/cpp/configuring_an_ide/kdevelop.html,/engine_details/development/configuring_an_ide/kdevelop.html
/development/cpp/configuring_an_ide/qt_creator.html,/engine_details/development/configuring_an_ide/qt_creator.html
/development/cpp/configuring_an_ide/visual_studio.html,/engine_details/development/configuring_an_ide/visual_studio.html
/development/cpp/configuring_an_ide/visual_studio_code.html,/engine_details/development/configuring_an_ide/visual_studio_code.html
/development/cpp/configuring_an_ide/xcode.html,/engine_details/development/configuring_an_ide/xcode.html
/development/cpp/core_types.html,/engine_details/development/core_and_modules/core_types.html
/development/cpp/custom_audiostreams.html,/engine_details/development/core_and_modules/custom_audiostreams.html
/development/cpp/custom_godot_servers.html,/engine_details/development/core_and_modules/custom_godot_servers.html
/development/cpp/custom_modules_in_cpp.html,/engine_details/development/core_and_modules/custom_modules_in_cpp.html
/development/cpp/custom_resource_format_loaders.html,/contributing/development/core_and_modules/custom_resource_format_loaders.html
/development/cpp/index.html,/contributing/development/core_and_modules/index.html
/development/cpp/inheritance_class_tree.html,/contributing/development/core_and_modules/inheritance_class_tree.html
/development/cpp/introduction_to_godot_development.html,/contributing/development/core_and_modules/introduction_to_godot_development.html
/development/cpp/macos_debug.html,/contributing/development/debugging/macos_debug.html
/development/cpp/object_class.html,/contributing/development/core_and_modules/object_class.html
/development/cpp/unit_testing.html,/contributing/development/core_and_modules/unit_testing.html
/development/cpp/using_cpp_profilers.html,/contributing/development/debugging/using_cpp_profilers.html
/development/cpp/variant_class.html,/contributing/development/core_and_modules/variant_class.html
/development/cpp/vulkan/index.html,/contributing/development/debugging/vulkan/index.html
/development/cpp/vulkan/vulkan_validation_layers.html,/contributing/development/debugging/vulkan/vulkan_validation_layers.html
/development/editor/creating_icons.html,/contributing/development/editor/creating_icons.html
/development/editor/editor_style_guide.html,/contributing/development/editor/editor_style_guide.html
/development/editor/index.html,/contributing/development/editor/index.html
/development/editor/introduction_to_editor_development.html,/contributing/development/editor/introduction_to_editor_development.html
/development/file_formats/gdscript_grammar.html,/contributing/development/file_formats/gdscript_grammar.html
/development/file_formats/index.html,/contributing/development/file_formats/index.html
/development/file_formats/tscn.html,/contributing/development/file_formats/tscn.html
/development/cpp/index.html,/engine_details/development/core_and_modules/index.html
/development/cpp/inheritance_class_tree.html,/engine_details/development/core_and_modules/inheritance_class_tree.html
/development/cpp/introduction_to_godot_development.html,/engine_details/development/core_and_modules/introduction_to_godot_development.html
/development/cpp/macos_debug.html,/engine_details/development/debugging/macos_debug.html
/development/cpp/object_class.html,/engine_details/development/core_and_modules/object_class.html
/development/cpp/unit_testing.html,/engine_details/development/core_and_modules/unit_testing.html
/development/cpp/using_cpp_profilers.html,/engine_details/development/debugging/using_cpp_profilers.html
/development/cpp/variant_class.html,/engine_details/development/core_and_modules/variant_class.html
/development/cpp/vulkan/index.html,/engine_details/development/debugging/vulkan/index.html
/development/cpp/vulkan/vulkan_validation_layers.html,/engine_details/development/debugging/vulkan/vulkan_validation_layers.html
/development/editor/creating_icons.html,/engine_details/editor/creating_icons.html
/development/editor/index.html,/engine_details/editor/index.html
/development/editor/introduction_to_editor_development.html,/engine_details/editor/introduction_to_editor_development.html
/development/file_formats/gdscript_grammar.html,/engine_details/development/file_formats/gdscript_grammar.html
/development/file_formats/index.html,/engine_details/development/file_formats/index.html
/development/file_formats/tscn.html,/engine_details/development/file_formats/tscn.html
/development/plugins/import_plugins.html,/tutorials/plugins/editor/import_plugins.html
/development/plugins/index.html,/tutorials/plugins/editor/index.html
/development/plugins/making_plugins.html,/tutorials/plugins/editor/making_plugins.html
Expand Down
2 changes: 1 addition & 1 deletion about/complying_with_licenses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ with the original one.

This section covers compliance with licenses from a user perspective.
If you are interested in licence compliance as a contributor, you can find
guidelines :ref:`here <doc_best_practices_for_engine_contributors_license_compliance>`.
guidelines `here <https://contributing.godotengine.org/en/latest/engine/guidelines/best_practices.html#don-t-use-complex-canned-solutions-for-simple-problems>`__.

.. tip::

Expand Down
22 changes: 1 addition & 21 deletions about/docs_changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ Contributing
~~~~~~~~~~~~

- :ref:`doc_handling_compatibility_breakages`
- :ref:`doc_ways_to_contribute`

GDExtension
~~~~~~~~~~~
Expand Down Expand Up @@ -215,11 +214,6 @@ Shaders

- :ref:`doc_compute_shaders`

Workflow
~~~~~~~~

- :ref:`doc_pr_review_guidelines`

XR
~~

Expand Down Expand Up @@ -253,11 +247,6 @@ Editor
New pages since version 3.3
---------------------------

C++
~~~

- :ref:`doc_cpp_usage_guidelines`

GDScript
~~~~~~~~

Expand All @@ -283,19 +272,10 @@ Best practices

- :ref:`doc_version_control_systems`

Community
~~~~~~~~~

- :ref:`doc_best_practices_for_engine_contributors`
- :ref:`doc_bisecting_regressions`
- :ref:`doc_editor_and_docs_localization`

Development
~~~~~~~~~~~

- :ref:`doc_introduction_to_editor_development`
- :ref:`doc_editor_style_guide`
- :ref:`doc_common_engine_methods_and_macros`
- :ref:`doc_common_engine_methods_and_macros_error_macros`
- :ref:`doc_vulkan_validation_layers`
- :ref:`doc_gdscript_grammar`
- Configuring an IDE: :ref:`doc_configuring_an_ide_code_blocks`
Expand Down
4 changes: 2 additions & 2 deletions about/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ compile the engine from sources, or how to build the documentation. You also nee
get familiar with Git, a version control system that Godot developers use.

We explain how to work with the engine source, how to edit the documentation, and
what other ways to contribute are there in our :ref:`documentation for contributors <doc_ways_to_contribute>`.
what other ways to contribute are there in our `documentation for contributors <https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html>`__.

I have a great idea for Godot. How can I share it?
--------------------------------------------------
Expand Down Expand Up @@ -629,7 +629,7 @@ for the rest of the game.
How can I support Godot development or contribute?
--------------------------------------------------

See :ref:`doc_ways_to_contribute`.
See `How to contribute <https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html>`__.

Who is working on Godot? How can I contact you?
-----------------------------------------------
Expand Down
Loading
Loading