From dbfe3b1d2689586000cd6974bbe6b44386bb03f2 Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Mon, 26 Dec 2022 19:58:43 +0300 Subject: [PATCH] Reorganize documentation for contributors - Merge Community/Contributing and Engine Development into one top-level section, Contributing. - Structure it in a way that gives equal priority to various ways to contribute, including documentation. - Rename several articles to be more comprehensive and in line with the overall state of the documentation. - Rewrite the guide for class reference contributions. --- _tools/redirects/redirects.csv | 63 ++++++++++ about/introduction.rst | 15 +-- community/contributing/index.rst | 108 ----------------- .../updating_the_class_reference.rst | 76 ------------ ...best_practices_for_engine_contributors.rst | 0 .../development}/code_style_guidelines.rst | 0 .../compiling/compiling_for_android.rst | 0 .../compiling/compiling_for_ios.rst | 0 .../compiling/compiling_for_linuxbsd.rst | 0 .../compiling/compiling_for_macos.rst | 0 .../compiling/compiling_for_uwp.rst | 0 .../compiling/compiling_for_web.rst | 0 .../compiling/compiling_for_windows.rst | 0 .../compiling/compiling_with_mono.rst | 0 .../compiling_with_script_encryption_key.rst | 0 .../cross-compiling_for_ios_on_linux.rst | 0 .../development}/compiling/getting_source.rst | 0 .../compiling/img/andtemplates.png | Bin .../compiling/img/encryption_key.png | Bin .../compiling/img/lintemplates.png | Bin .../compiling/img/wintemplates.png | Bin .../development}/compiling/index.rst | 4 +- .../introduction_to_the_buildsystem.rst | 0 .../compiling/optimizing_for_size.rst | 0 .../configuring_an_ide/android_studio.rst | 0 .../development}/configuring_an_ide/clion.rst | 0 .../configuring_an_ide/code_blocks.rst | 0 .../img/android_studio_setup_project_1.png | Bin .../img/clion-add-configuration.png | Bin .../clion-add-custom-build-application.png | Bin .../img/clion-build-run.png | Bin .../img/clion-create-build-tool.png | Bin .../img/clion-create-clean-tool.png | Bin .../img/clion-external-tools.png | Bin .../img/clion-preferences.png | Bin .../img/clion-run-configuration.png | Bin .../img/clion-select-tools.png | Bin .../configuring_an_ide/img/clion-target.png | Bin .../img/code_block_use_tab_character.png | Bin .../img/code_blocks_add_files_recursively.png | Bin .../img/code_blocks_build_targets.png | Bin ...code_blocks_compiler_and_configuration.png | Bin .../img/code_blocks_file_new_project.png | Bin .../img/code_blocks_new_empty_project.png | Bin .../img/code_blocks_open_build_options.png | Bin .../img/code_blocks_open_properties.png | Bin .../img/code_blocks_project_properties.png | Bin ...code_blocks_project_title_and_location.png | Bin .../img/code_blocks_scons_clean.png | Bin .../img/code_blocks_scons_minimum.png | Bin .../img/code_blocks_scons_windows.png | Bin .../img/code_blocks_select_files.png | Bin .../code_blocks_update_editor_settings.png | Bin .../img/code_blocks_wizard_welcome.png | Bin .../img/kdevelop_addincludes.png | Bin .../img/kdevelop_buildconfig.png | Bin .../img/kdevelop_configlaunches.png | Bin .../img/kdevelop_configlaunches2.png | Bin .../img/kdevelop_custombuild.png | Bin .../img/kdevelop_newproject.png | Bin .../img/kdevelop_openconfig.png | Bin .../img/qtcreator-apply-import-filter.png | Bin .../img/qtcreator-edit-codestyle.png | Bin .../img/qtcreator-edit-files-menu.png | Bin .../img/qtcreator-new-project.png | Bin .../img/qtcreator-options-cpp.png | Bin .../img/qtcreator-project-name-includes.png | Bin .../img/qtcreator-projects-build.png | Bin .../img/qtcreator-run-command.png | Bin .../img/qtcreator-set-project-path.png | Bin .../img/qtcreator-set-scons-command.png | Bin .../img/vs_1_install_cpp_package.png | Bin .../img/vs_2_project_properties.png | Bin .../img/vs_3_debug_command_line.png | Bin .../img/vs_4_debugging_main.png | Bin .../img/vscode_1_create_launch.json.png | Bin .../img/vscode_2_launch.json.png | Bin .../img/vscode_3_tasks.json.png | Bin .../img/vscode_configure_task.png | Bin .../img/vscode_create_tasksjson.png | Bin .../img/vscode_create_tasksjson_others.png | Bin .../xcode_1_create_external_build_project.png | Bin .../img/xcode_2_configure_scons.png | Bin .../img/xcode_3_add_new_target.png | Bin .../xcode_4_select_command_line_target.png | Bin ...de_5_after_add_godot_source_to_project.png | Bin ..._6_after_add_godot_source_to_project_2.png | Bin .../img/xcode_7_setup_build_post_action.png | Bin .../img/xcode_8_setup_run_scheme.png | Bin .../development}/configuring_an_ide/index.rst | 0 .../configuring_an_ide/kdevelop.rst | 0 .../configuring_an_ide/qt_creator.rst | 0 .../configuring_an_ide/visual_studio.rst | 0 .../configuring_an_ide/visual_studio_code.rst | 0 .../development}/configuring_an_ide/xcode.rst | 0 .../binding_to_external_libraries.rst | 0 .../common_engine_methods_and_macros.rst | 0 .../core_and_modules}/core_types.rst | 0 .../core_and_modules}/custom_audiostreams.rst | 0 .../custom_godot_servers.rst | 0 .../custom_modules_in_cpp.rst | 2 +- .../custom_resource_format_loaders.rst | 0 .../core_and_modules}/files/class_tree.zip | Bin .../core_and_modules}/img/Control.png | Bin .../core_and_modules}/img/Node2D.png | Bin .../core_and_modules}/img/Object.png | Bin .../core_and_modules}/img/Reference.png | Bin .../core_and_modules}/img/Spatial.png | Bin .../img/architecture_diagram.jpg | Bin .../development/core_and_modules}/index.rst | 30 +---- .../inheritance_class_tree.rst | 0 .../introduction_to_godot_development.rst | 0 .../core_and_modules}/object_class.rst | 0 .../core_and_modules}/unit_testing.rst | 0 .../core_and_modules}/variant_class.rst | 0 .../development}/cpp_usage_guidelines.rst | 0 .../img/cpp_profiler_hotspot_flame_graph.png | Bin .../img/cpp_profiler_hotspot_record.png | Bin .../img/cpp_profiler_hotspot_view_results.png | Bin .../img/cpp_profiler_hotspot_welcome.png | Bin .../img/cpp_profiler_time_profiler.png | Bin .../img/cpp_profiler_time_profiler_record.png | Bin .../img/cpp_profiler_time_profiler_result.png | Bin ...p_profiler_verysleepy_results_filtered.png | Bin ...cpp_profiler_verysleepy_select_process.png | Bin .../img/cpp_profiler_xcode_menu.png | Bin contributing/development/debugging/index.rst | 12 ++ .../development/debugging}/macos_debug.rst | 0 .../debugging}/using_cpp_profilers.rst | 0 .../development/debugging}/vulkan/index.rst | 0 .../vulkan/vulkan_validation_layers.rst | 0 .../development}/editor/creating_icons.rst | 0 .../editor/editor_style_guide.rst | 0 .../development}/editor/index.rst | 0 .../introduction_to_editor_development.rst | 0 .../file_formats/gdscript_grammar.rst | 0 .../development}/file_formats/index.rst | 0 .../development}/file_formats/tscn.rst | 0 .../development}/img/best_practices1.png | Bin .../development}/img/best_practices2.png | Bin .../development}/img/best_practices3.png | Bin .../development}/img/best_practices4.png | Bin .../development}/img/best_practices5.png | Bin .../development}/img/best_practices6.png | Bin .../development}/img/best_practices7.png | Bin .../development}/img/best_practices8.png | Bin contributing/development/index.rst | 25 ++++ .../documentation}/building_the_manual.rst | 0 .../documentation/class_reference_primer.rst | 20 +--- .../documentation}/content_guidelines.rst | 0 .../contributing_to_the_documentation.rst | 4 +- .../docs_writing_guidelines.rst | 4 +- .../editor_and_docs_localization.rst | 6 +- .../img/editor-vocabulary-overview.png | Bin .../img/l10n_01_language_list.png | Bin .../img/l10n_02_new_translation.png | Bin .../img/l10n_03_translation_overview.png | Bin .../img/l10n_04_translation_interface.png | Bin .../img/l10n_05_search_location.png | Bin .../img/l10n_06_browse_by_location.png | Bin .../img/l10n_07_download_po_file.png | Bin .../img/l10n_08_edit_on_github.png | Bin .../img/l10n_09_path_to_image.png | Bin contributing/documentation/index.rst | 67 +++++++++++ .../updating_the_class_reference.rst | 112 ++++++++++++++++++ .../ways_to_contribute.rst | 4 +- .../workflow}/bisecting_regressions.rst | 0 .../workflow}/bug_triage_guidelines.rst | 0 .../workflow}/img/github_fork_button.png | Bin .../workflow}/img/github_fork_make_pr.png | Bin .../workflow}/img/github_fork_url.png | Bin .../testing_pull_requests_access_checks.png | Bin .../img/testing_pull_requests_access_fork.png | Bin ...testing_pull_requests_checks_artifacts.png | Bin ...testing_pull_requests_checks_platforms.png | Bin .../img/testing_pull_requests_fork_zip.png | Bin .../testing_pull_requests_nightly_link.png | Bin contributing/workflow/index.rst | 18 +++ .../workflow}/pr_workflow.rst | 0 .../workflow}/testing_pull_requests.rst | 0 index.rst | 13 +- tutorials/ui/bbcode_in_richtextlabel.rst | 2 +- 182 files changed, 332 insertions(+), 253 deletions(-) delete mode 100644 community/contributing/index.rst delete mode 100644 community/contributing/updating_the_class_reference.rst rename {community/contributing => contributing/development}/best_practices_for_engine_contributors.rst (100%) rename {community/contributing => contributing/development}/code_style_guidelines.rst (100%) rename {development => contributing/development}/compiling/compiling_for_android.rst (100%) rename {development => contributing/development}/compiling/compiling_for_ios.rst (100%) rename {development => contributing/development}/compiling/compiling_for_linuxbsd.rst (100%) rename {development => contributing/development}/compiling/compiling_for_macos.rst (100%) rename {development => contributing/development}/compiling/compiling_for_uwp.rst (100%) rename {development => contributing/development}/compiling/compiling_for_web.rst (100%) rename {development => contributing/development}/compiling/compiling_for_windows.rst (100%) rename {development => contributing/development}/compiling/compiling_with_mono.rst (100%) rename {development => contributing/development}/compiling/compiling_with_script_encryption_key.rst (100%) rename {development => contributing/development}/compiling/cross-compiling_for_ios_on_linux.rst (100%) rename {development => contributing/development}/compiling/getting_source.rst (100%) rename {development => contributing/development}/compiling/img/andtemplates.png (100%) rename {development => contributing/development}/compiling/img/encryption_key.png (100%) rename {development => contributing/development}/compiling/img/lintemplates.png (100%) rename {development => contributing/development}/compiling/img/wintemplates.png (100%) rename {development => contributing/development}/compiling/index.rst (90%) rename {development => contributing/development}/compiling/introduction_to_the_buildsystem.rst (100%) rename {development => contributing/development}/compiling/optimizing_for_size.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/android_studio.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/clion.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/code_blocks.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/android_studio_setup_project_1.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-add-configuration.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-add-custom-build-application.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-build-run.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-create-build-tool.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-create-clean-tool.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-external-tools.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-preferences.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-run-configuration.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-select-tools.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/clion-target.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_block_use_tab_character.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_add_files_recursively.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_build_targets.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_compiler_and_configuration.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_file_new_project.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_new_empty_project.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_open_build_options.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_open_properties.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_project_properties.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_project_title_and_location.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_scons_clean.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_scons_minimum.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_scons_windows.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_select_files.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_update_editor_settings.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/code_blocks_wizard_welcome.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_addincludes.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_buildconfig.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_configlaunches.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_configlaunches2.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_custombuild.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_newproject.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/kdevelop_openconfig.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-apply-import-filter.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-edit-codestyle.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-edit-files-menu.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-new-project.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-options-cpp.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-project-name-includes.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-projects-build.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-run-command.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-set-project-path.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/qtcreator-set-scons-command.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vs_1_install_cpp_package.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vs_2_project_properties.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vs_3_debug_command_line.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vs_4_debugging_main.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vscode_1_create_launch.json.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vscode_2_launch.json.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vscode_3_tasks.json.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vscode_configure_task.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vscode_create_tasksjson.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/vscode_create_tasksjson_others.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_1_create_external_build_project.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_2_configure_scons.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_3_add_new_target.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_4_select_command_line_target.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_7_setup_build_post_action.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/img/xcode_8_setup_run_scheme.png (100%) rename {development/cpp => contributing/development}/configuring_an_ide/index.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/kdevelop.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/qt_creator.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/visual_studio.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/visual_studio_code.rst (100%) rename {development/cpp => contributing/development}/configuring_an_ide/xcode.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/binding_to_external_libraries.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/common_engine_methods_and_macros.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/core_types.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/custom_audiostreams.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/custom_godot_servers.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/custom_modules_in_cpp.rst (99%) rename {development/cpp => contributing/development/core_and_modules}/custom_resource_format_loaders.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/files/class_tree.zip (100%) rename {development/cpp => contributing/development/core_and_modules}/img/Control.png (100%) rename {development/cpp => contributing/development/core_and_modules}/img/Node2D.png (100%) rename {development/cpp => contributing/development/core_and_modules}/img/Object.png (100%) rename {development/cpp => contributing/development/core_and_modules}/img/Reference.png (100%) rename {development/cpp => contributing/development/core_and_modules}/img/Spatial.png (100%) rename {development/cpp => contributing/development/core_and_modules}/img/architecture_diagram.jpg (100%) rename {development/cpp => contributing/development/core_and_modules}/index.rst (54%) rename {development/cpp => contributing/development/core_and_modules}/inheritance_class_tree.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/introduction_to_godot_development.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/object_class.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/unit_testing.rst (100%) rename {development/cpp => contributing/development/core_and_modules}/variant_class.rst (100%) rename {community/contributing => contributing/development}/cpp_usage_guidelines.rst (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_hotspot_flame_graph.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_hotspot_record.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_hotspot_view_results.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_hotspot_welcome.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_time_profiler.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_time_profiler_record.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_time_profiler_result.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_verysleepy_results_filtered.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_verysleepy_select_process.png (100%) rename {development/cpp => contributing/development/debugging}/img/cpp_profiler_xcode_menu.png (100%) create mode 100644 contributing/development/debugging/index.rst rename {development/cpp => contributing/development/debugging}/macos_debug.rst (100%) rename {development/cpp => contributing/development/debugging}/using_cpp_profilers.rst (100%) rename {development/cpp => contributing/development/debugging}/vulkan/index.rst (100%) rename {development/cpp => contributing/development/debugging}/vulkan/vulkan_validation_layers.rst (100%) rename {development => contributing/development}/editor/creating_icons.rst (100%) rename {development => contributing/development}/editor/editor_style_guide.rst (100%) rename {development => contributing/development}/editor/index.rst (100%) rename {development => contributing/development}/editor/introduction_to_editor_development.rst (100%) rename {development => contributing/development}/file_formats/gdscript_grammar.rst (100%) rename {development => contributing/development}/file_formats/index.rst (100%) rename {development => contributing/development}/file_formats/tscn.rst (100%) rename {community/contributing => contributing/development}/img/best_practices1.png (100%) rename {community/contributing => contributing/development}/img/best_practices2.png (100%) rename {community/contributing => contributing/development}/img/best_practices3.png (100%) rename {community/contributing => contributing/development}/img/best_practices4.png (100%) rename {community/contributing => contributing/development}/img/best_practices5.png (100%) rename {community/contributing => contributing/development}/img/best_practices6.png (100%) rename {community/contributing => contributing/development}/img/best_practices7.png (100%) rename {community/contributing => contributing/development}/img/best_practices8.png (100%) create mode 100644 contributing/development/index.rst rename {community/contributing => contributing/documentation}/building_the_manual.rst (100%) rename community/contributing/class_reference_writing_guidelines.rst => contributing/documentation/class_reference_primer.rst (96%) rename {community/contributing => contributing/documentation}/content_guidelines.rst (100%) rename {community/contributing => contributing/documentation}/contributing_to_the_documentation.rst (97%) rename {community/contributing => contributing/documentation}/docs_writing_guidelines.rst (99%) rename {community/contributing => contributing/documentation}/editor_and_docs_localization.rst (99%) rename {community/contributing => contributing/documentation}/img/editor-vocabulary-overview.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_01_language_list.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_02_new_translation.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_03_translation_overview.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_04_translation_interface.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_05_search_location.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_06_browse_by_location.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_07_download_po_file.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_08_edit_on_github.png (100%) rename {community/contributing => contributing/documentation}/img/l10n_09_path_to_image.png (100%) create mode 100644 contributing/documentation/index.rst create mode 100644 contributing/documentation/updating_the_class_reference.rst rename {community/contributing => contributing}/ways_to_contribute.rst (99%) rename {community/contributing => contributing/workflow}/bisecting_regressions.rst (100%) rename {community/contributing => contributing/workflow}/bug_triage_guidelines.rst (100%) rename {community/contributing => contributing/workflow}/img/github_fork_button.png (100%) rename {community/contributing => contributing/workflow}/img/github_fork_make_pr.png (100%) rename {community/contributing => contributing/workflow}/img/github_fork_url.png (100%) rename {community/contributing => contributing/workflow}/img/testing_pull_requests_access_checks.png (100%) rename {community/contributing => contributing/workflow}/img/testing_pull_requests_access_fork.png (100%) rename {community/contributing => contributing/workflow}/img/testing_pull_requests_checks_artifacts.png (100%) rename {community/contributing => contributing/workflow}/img/testing_pull_requests_checks_platforms.png (100%) rename {community/contributing => contributing/workflow}/img/testing_pull_requests_fork_zip.png (100%) rename {community/contributing => contributing/workflow}/img/testing_pull_requests_nightly_link.png (100%) create mode 100644 contributing/workflow/index.rst rename {community/contributing => contributing/workflow}/pr_workflow.rst (100%) rename {community/contributing => contributing/workflow}/testing_pull_requests.rst (100%) diff --git a/_tools/redirects/redirects.csv b/_tools/redirects/redirects.csv index eb4eec80f..237e26df0 100644 --- a/_tools/redirects/redirects.csv +++ b/_tools/redirects/redirects.csv @@ -1,6 +1,22 @@ source,destination /about/index.html,/index.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 @@ -11,7 +27,54 @@ source,destination /contributing/bug_triage_guidelines.html,/community/contributing/bug_triage_guidelines.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 +/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_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 /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/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/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 diff --git a/about/introduction.rst b/about/introduction.rst index f71925126..418c06fbe 100644 --- a/about/introduction.rst +++ b/about/introduction.rst @@ -89,19 +89,20 @@ relatively intuitive: new users. - The :ref:`sec-tutorials` section can be read as needed, in any order. It contains feature-specific tutorials and documentation. -- The :ref:`sec-devel` section is intended for advanced users and contributors +- The :ref:`sec-contributing` section gives the information related to contributing to + the engine development, e.g. how to report bugs, help with the documentation, etc. + It also contains subsections intended for advanced users and contributors to the engine development, with the information on compiling the engine, contributing to the editor, or developing C++ modules. -- The :ref:`sec-community` section gives the information related to contributing to - the engine development and the life of its community, e.g. how to report bugs, - help with the documentation, etc. It also points to various community channels - like Godot Contributors Chat and Discord and contains a list of recommended - third-party tutorials outside of this documentation. +- The :ref:`sec-community` section is dedicated to the life of its community. + It points to various community channels like Godot Contributors Chat and + Discord and contains a list of recommended third-party tutorials outside + of this documentation. - Finally, the :ref:`sec-class-ref` is the documentation of the Godot API, which is also available directly within the engine's script editor. It is generated automatically from a file in the main source repository, therefore the generated files of the documentation are not meant to be modified. See - :ref:`doc_class_reference_writing_guidelines` for details. + :ref:`doc_updating_the_class_reference` for details. In addition to this documentation, you may also want to take a look at the various `Godot demo projects `_. diff --git a/community/contributing/index.rst b/community/contributing/index.rst deleted file mode 100644 index 2990e4fa2..000000000 --- a/community/contributing/index.rst +++ /dev/null @@ -1,108 +0,0 @@ -Contributing -============ - -Everyone is most welcome to contribute to Godot. Here are some ways in which you -can contribute to the project: - -- Improving the engine by fixing bugs, coding new features, or refining existing ones. -- Writing or proofreading documentation. You can contribute both to this - reference manual or the code reference. -- Translating the editor or documentation from English to other languages. -- Reporting issues or `writing detailed proposals - `__. - -Getting started ---------------- - -You would like to contribute but you don't know how or what to do? You can get -answers below. - -.. toctree:: - :maxdepth: 1 - :name: toc-community-getting-started - - ways_to_contribute - -.. _doc_community_contributing_to_the_engine: - -Contributing to the engine --------------------------- - -The guides below explain how to contribute to the engine's core. You will learn -about the code style, the contribution workflow, and more. - -.. toctree:: - :maxdepth: 1 - :name: toc-community-contributing-to-the-engine - - best_practices_for_engine_contributors - pr_workflow - testing_pull_requests - bisecting_regressions - bug_triage_guidelines - code_style_guidelines - cpp_usage_guidelines - -.. _doc_community_writing_documentation: - -Writing documentation ---------------------- - -We always need help to improve the documentation, be it the class reference or -the manual. Below, you can find our content and writing guidelines and -concrete guides to make changes to the documentation. - -Guidelines -~~~~~~~~~~ - -Here are the principles and guidelines we strive to follow to write accessible -documentation. - -.. toctree:: - :maxdepth: 1 - :name: toc-community-writing-guidelines - - content_guidelines - docs_writing_guidelines - -Writing the manual -~~~~~~~~~~~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - :name: toc-community-documentation - - contributing_to_the_documentation - building_the_manual - -Class reference guides -~~~~~~~~~~~~~~~~~~~~~~ - -The pages below focus on the class reference. - -As the reference is included in the Godot editor, its source files are part of -the `godot repository `_. We use XML files -to write it, so the process to contribute to the class reference differs from -writing the online manual. - -.. toctree:: - :maxdepth: 1 - :name: toc-community-class-reference - - updating_the_class_reference - class_reference_writing_guidelines - -.. _doc_community_translating_the_documentation: - -Translating the documentation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The community is always working hard on making Godot and its documentation -available to more people. Localizing the documentation is a colossal and ongoing -effort you can be part of. - -.. toctree:: - :maxdepth: 1 - :name: toc-community-localization - - editor_and_docs_localization diff --git a/community/contributing/updating_the_class_reference.rst b/community/contributing/updating_the_class_reference.rst deleted file mode 100644 index cbbdf89c5..000000000 --- a/community/contributing/updating_the_class_reference.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. _doc_updating_the_class_reference: - -Contributing to the class reference -=================================== - -.. highlight:: shell - -The class reference is available online in the :ref:`classes ` -section of the documentation and in the Godot editor, from the help menu. - -In the class reference, some methods, variables, and signals lack descriptions. -Others changed with recent releases and need updates. The developers can't write -the entire reference on their own. Godot needs you, and all of us, to -contribute. - -**Important:** If you plan to make large changes, you should create an issue on -the `godot-docs repository `_ -or comment on an existing issue. Doing so lets others know you're already -taking care of a given class. - -.. seealso:: - - You can find the writing guidelines for the class reference :ref:`here `. - - For details on Git usage and the pull request workflow, please - refer to the :ref:`doc_pr_workflow` page. - - If you want to translate the class reference from English to another - language, see :ref:`doc_editor_and_docs_localization`. - - This guide is also available as a `video tutorial on YouTube - `_. - -.. seealso:: - - Not sure which class to contribute to? Take a look at the class reference's - completion status `here `_. - -You can find the source files for the class reference in Godot's GitHub -repository: `doc/classes/ -`_. - -.. note:: For some modules in the engine's source code, you'll find the XML - files in the ``modules//doc_classes/`` directory instead. - -.. warning:: Always edit the API reference through these source XML files. Do - not edit the generated ``.rst`` files :ref:`in the online documentation - `, hosted in the `godot-docs - `_ repository. - -.. warning:: - - Unless you make minor changes, like fixing a typo, we do not recommend using the GitHub web editor to edit the class reference's XML. - - It lacks features to edit XML well, like keeping indentations consistent, and it does not allow amending commits based on reviews. - - Also, it doesn't allow you to test your changes in the engine or with validation - scripts as described in - :ref:`doc_class_reference_writing_guidelines_editing_xml`. - -Updating the documentation template -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When you create a new class or modify the engine's API, you need to re-generate the XML files in ``doc/classes/``. - -To do so, you first need to compile Godot. See the -:ref:`doc_introduction_to_the_buildsystem` page to learn how. Then, execute the -compiled Godot binary from the Godot root directory with the ``--doctool`` option. -For example, if you're on 64-bit Linux, the command is:: - - ./bin/godot.linuxbsd.tools.64 --doctool - -The XML files in doc/classes should then be up-to-date with current Godot Engine -features. You can then check what changed using the ``git diff`` command. Please -only include changes that are relevant to your work on the API in your commits. -You can discard changes in other XML files using ``git checkout``. diff --git a/community/contributing/best_practices_for_engine_contributors.rst b/contributing/development/best_practices_for_engine_contributors.rst similarity index 100% rename from community/contributing/best_practices_for_engine_contributors.rst rename to contributing/development/best_practices_for_engine_contributors.rst diff --git a/community/contributing/code_style_guidelines.rst b/contributing/development/code_style_guidelines.rst similarity index 100% rename from community/contributing/code_style_guidelines.rst rename to contributing/development/code_style_guidelines.rst diff --git a/development/compiling/compiling_for_android.rst b/contributing/development/compiling/compiling_for_android.rst similarity index 100% rename from development/compiling/compiling_for_android.rst rename to contributing/development/compiling/compiling_for_android.rst diff --git a/development/compiling/compiling_for_ios.rst b/contributing/development/compiling/compiling_for_ios.rst similarity index 100% rename from development/compiling/compiling_for_ios.rst rename to contributing/development/compiling/compiling_for_ios.rst diff --git a/development/compiling/compiling_for_linuxbsd.rst b/contributing/development/compiling/compiling_for_linuxbsd.rst similarity index 100% rename from development/compiling/compiling_for_linuxbsd.rst rename to contributing/development/compiling/compiling_for_linuxbsd.rst diff --git a/development/compiling/compiling_for_macos.rst b/contributing/development/compiling/compiling_for_macos.rst similarity index 100% rename from development/compiling/compiling_for_macos.rst rename to contributing/development/compiling/compiling_for_macos.rst diff --git a/development/compiling/compiling_for_uwp.rst b/contributing/development/compiling/compiling_for_uwp.rst similarity index 100% rename from development/compiling/compiling_for_uwp.rst rename to contributing/development/compiling/compiling_for_uwp.rst diff --git a/development/compiling/compiling_for_web.rst b/contributing/development/compiling/compiling_for_web.rst similarity index 100% rename from development/compiling/compiling_for_web.rst rename to contributing/development/compiling/compiling_for_web.rst diff --git a/development/compiling/compiling_for_windows.rst b/contributing/development/compiling/compiling_for_windows.rst similarity index 100% rename from development/compiling/compiling_for_windows.rst rename to contributing/development/compiling/compiling_for_windows.rst diff --git a/development/compiling/compiling_with_mono.rst b/contributing/development/compiling/compiling_with_mono.rst similarity index 100% rename from development/compiling/compiling_with_mono.rst rename to contributing/development/compiling/compiling_with_mono.rst diff --git a/development/compiling/compiling_with_script_encryption_key.rst b/contributing/development/compiling/compiling_with_script_encryption_key.rst similarity index 100% rename from development/compiling/compiling_with_script_encryption_key.rst rename to contributing/development/compiling/compiling_with_script_encryption_key.rst diff --git a/development/compiling/cross-compiling_for_ios_on_linux.rst b/contributing/development/compiling/cross-compiling_for_ios_on_linux.rst similarity index 100% rename from development/compiling/cross-compiling_for_ios_on_linux.rst rename to contributing/development/compiling/cross-compiling_for_ios_on_linux.rst diff --git a/development/compiling/getting_source.rst b/contributing/development/compiling/getting_source.rst similarity index 100% rename from development/compiling/getting_source.rst rename to contributing/development/compiling/getting_source.rst diff --git a/development/compiling/img/andtemplates.png b/contributing/development/compiling/img/andtemplates.png similarity index 100% rename from development/compiling/img/andtemplates.png rename to contributing/development/compiling/img/andtemplates.png diff --git a/development/compiling/img/encryption_key.png b/contributing/development/compiling/img/encryption_key.png similarity index 100% rename from development/compiling/img/encryption_key.png rename to contributing/development/compiling/img/encryption_key.png diff --git a/development/compiling/img/lintemplates.png b/contributing/development/compiling/img/lintemplates.png similarity index 100% rename from development/compiling/img/lintemplates.png rename to contributing/development/compiling/img/lintemplates.png diff --git a/development/compiling/img/wintemplates.png b/contributing/development/compiling/img/wintemplates.png similarity index 100% rename from development/compiling/img/wintemplates.png rename to contributing/development/compiling/img/wintemplates.png diff --git a/development/compiling/index.rst b/contributing/development/compiling/index.rst similarity index 90% rename from development/compiling/index.rst rename to contributing/development/compiling/index.rst index b9f7415d9..8265925b8 100644 --- a/development/compiling/index.rst +++ b/contributing/development/compiling/index.rst @@ -1,5 +1,5 @@ -Compiling -========= +Building from source +==================== .. toctree:: :maxdepth: 1 diff --git a/development/compiling/introduction_to_the_buildsystem.rst b/contributing/development/compiling/introduction_to_the_buildsystem.rst similarity index 100% rename from development/compiling/introduction_to_the_buildsystem.rst rename to contributing/development/compiling/introduction_to_the_buildsystem.rst diff --git a/development/compiling/optimizing_for_size.rst b/contributing/development/compiling/optimizing_for_size.rst similarity index 100% rename from development/compiling/optimizing_for_size.rst rename to contributing/development/compiling/optimizing_for_size.rst diff --git a/development/cpp/configuring_an_ide/android_studio.rst b/contributing/development/configuring_an_ide/android_studio.rst similarity index 100% rename from development/cpp/configuring_an_ide/android_studio.rst rename to contributing/development/configuring_an_ide/android_studio.rst diff --git a/development/cpp/configuring_an_ide/clion.rst b/contributing/development/configuring_an_ide/clion.rst similarity index 100% rename from development/cpp/configuring_an_ide/clion.rst rename to contributing/development/configuring_an_ide/clion.rst diff --git a/development/cpp/configuring_an_ide/code_blocks.rst b/contributing/development/configuring_an_ide/code_blocks.rst similarity index 100% rename from development/cpp/configuring_an_ide/code_blocks.rst rename to contributing/development/configuring_an_ide/code_blocks.rst diff --git a/development/cpp/configuring_an_ide/img/android_studio_setup_project_1.png b/contributing/development/configuring_an_ide/img/android_studio_setup_project_1.png similarity index 100% rename from development/cpp/configuring_an_ide/img/android_studio_setup_project_1.png rename to contributing/development/configuring_an_ide/img/android_studio_setup_project_1.png diff --git a/development/cpp/configuring_an_ide/img/clion-add-configuration.png b/contributing/development/configuring_an_ide/img/clion-add-configuration.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-add-configuration.png rename to contributing/development/configuring_an_ide/img/clion-add-configuration.png diff --git a/development/cpp/configuring_an_ide/img/clion-add-custom-build-application.png b/contributing/development/configuring_an_ide/img/clion-add-custom-build-application.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-add-custom-build-application.png rename to contributing/development/configuring_an_ide/img/clion-add-custom-build-application.png diff --git a/development/cpp/configuring_an_ide/img/clion-build-run.png b/contributing/development/configuring_an_ide/img/clion-build-run.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-build-run.png rename to contributing/development/configuring_an_ide/img/clion-build-run.png diff --git a/development/cpp/configuring_an_ide/img/clion-create-build-tool.png b/contributing/development/configuring_an_ide/img/clion-create-build-tool.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-create-build-tool.png rename to contributing/development/configuring_an_ide/img/clion-create-build-tool.png diff --git a/development/cpp/configuring_an_ide/img/clion-create-clean-tool.png b/contributing/development/configuring_an_ide/img/clion-create-clean-tool.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-create-clean-tool.png rename to contributing/development/configuring_an_ide/img/clion-create-clean-tool.png diff --git a/development/cpp/configuring_an_ide/img/clion-external-tools.png b/contributing/development/configuring_an_ide/img/clion-external-tools.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-external-tools.png rename to contributing/development/configuring_an_ide/img/clion-external-tools.png diff --git a/development/cpp/configuring_an_ide/img/clion-preferences.png b/contributing/development/configuring_an_ide/img/clion-preferences.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-preferences.png rename to contributing/development/configuring_an_ide/img/clion-preferences.png diff --git a/development/cpp/configuring_an_ide/img/clion-run-configuration.png b/contributing/development/configuring_an_ide/img/clion-run-configuration.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-run-configuration.png rename to contributing/development/configuring_an_ide/img/clion-run-configuration.png diff --git a/development/cpp/configuring_an_ide/img/clion-select-tools.png b/contributing/development/configuring_an_ide/img/clion-select-tools.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-select-tools.png rename to contributing/development/configuring_an_ide/img/clion-select-tools.png diff --git a/development/cpp/configuring_an_ide/img/clion-target.png b/contributing/development/configuring_an_ide/img/clion-target.png similarity index 100% rename from development/cpp/configuring_an_ide/img/clion-target.png rename to contributing/development/configuring_an_ide/img/clion-target.png diff --git a/development/cpp/configuring_an_ide/img/code_block_use_tab_character.png b/contributing/development/configuring_an_ide/img/code_block_use_tab_character.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_block_use_tab_character.png rename to contributing/development/configuring_an_ide/img/code_block_use_tab_character.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_add_files_recursively.png b/contributing/development/configuring_an_ide/img/code_blocks_add_files_recursively.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_add_files_recursively.png rename to contributing/development/configuring_an_ide/img/code_blocks_add_files_recursively.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_build_targets.png b/contributing/development/configuring_an_ide/img/code_blocks_build_targets.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_build_targets.png rename to contributing/development/configuring_an_ide/img/code_blocks_build_targets.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_compiler_and_configuration.png b/contributing/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_compiler_and_configuration.png rename to contributing/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_file_new_project.png b/contributing/development/configuring_an_ide/img/code_blocks_file_new_project.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_file_new_project.png rename to contributing/development/configuring_an_ide/img/code_blocks_file_new_project.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_new_empty_project.png b/contributing/development/configuring_an_ide/img/code_blocks_new_empty_project.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_new_empty_project.png rename to contributing/development/configuring_an_ide/img/code_blocks_new_empty_project.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_open_build_options.png b/contributing/development/configuring_an_ide/img/code_blocks_open_build_options.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_open_build_options.png rename to contributing/development/configuring_an_ide/img/code_blocks_open_build_options.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_open_properties.png b/contributing/development/configuring_an_ide/img/code_blocks_open_properties.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_open_properties.png rename to contributing/development/configuring_an_ide/img/code_blocks_open_properties.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_project_properties.png b/contributing/development/configuring_an_ide/img/code_blocks_project_properties.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_project_properties.png rename to contributing/development/configuring_an_ide/img/code_blocks_project_properties.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_project_title_and_location.png b/contributing/development/configuring_an_ide/img/code_blocks_project_title_and_location.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_project_title_and_location.png rename to contributing/development/configuring_an_ide/img/code_blocks_project_title_and_location.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_scons_clean.png b/contributing/development/configuring_an_ide/img/code_blocks_scons_clean.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_scons_clean.png rename to contributing/development/configuring_an_ide/img/code_blocks_scons_clean.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_scons_minimum.png b/contributing/development/configuring_an_ide/img/code_blocks_scons_minimum.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_scons_minimum.png rename to contributing/development/configuring_an_ide/img/code_blocks_scons_minimum.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_scons_windows.png b/contributing/development/configuring_an_ide/img/code_blocks_scons_windows.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_scons_windows.png rename to contributing/development/configuring_an_ide/img/code_blocks_scons_windows.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_select_files.png b/contributing/development/configuring_an_ide/img/code_blocks_select_files.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_select_files.png rename to contributing/development/configuring_an_ide/img/code_blocks_select_files.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_update_editor_settings.png b/contributing/development/configuring_an_ide/img/code_blocks_update_editor_settings.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_update_editor_settings.png rename to contributing/development/configuring_an_ide/img/code_blocks_update_editor_settings.png diff --git a/development/cpp/configuring_an_ide/img/code_blocks_wizard_welcome.png b/contributing/development/configuring_an_ide/img/code_blocks_wizard_welcome.png similarity index 100% rename from development/cpp/configuring_an_ide/img/code_blocks_wizard_welcome.png rename to contributing/development/configuring_an_ide/img/code_blocks_wizard_welcome.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_addincludes.png b/contributing/development/configuring_an_ide/img/kdevelop_addincludes.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_addincludes.png rename to contributing/development/configuring_an_ide/img/kdevelop_addincludes.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_buildconfig.png b/contributing/development/configuring_an_ide/img/kdevelop_buildconfig.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_buildconfig.png rename to contributing/development/configuring_an_ide/img/kdevelop_buildconfig.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_configlaunches.png b/contributing/development/configuring_an_ide/img/kdevelop_configlaunches.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_configlaunches.png rename to contributing/development/configuring_an_ide/img/kdevelop_configlaunches.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_configlaunches2.png b/contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_configlaunches2.png rename to contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_custombuild.png b/contributing/development/configuring_an_ide/img/kdevelop_custombuild.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_custombuild.png rename to contributing/development/configuring_an_ide/img/kdevelop_custombuild.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_newproject.png b/contributing/development/configuring_an_ide/img/kdevelop_newproject.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_newproject.png rename to contributing/development/configuring_an_ide/img/kdevelop_newproject.png diff --git a/development/cpp/configuring_an_ide/img/kdevelop_openconfig.png b/contributing/development/configuring_an_ide/img/kdevelop_openconfig.png similarity index 100% rename from development/cpp/configuring_an_ide/img/kdevelop_openconfig.png rename to contributing/development/configuring_an_ide/img/kdevelop_openconfig.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-apply-import-filter.png b/contributing/development/configuring_an_ide/img/qtcreator-apply-import-filter.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-apply-import-filter.png rename to contributing/development/configuring_an_ide/img/qtcreator-apply-import-filter.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-edit-codestyle.png b/contributing/development/configuring_an_ide/img/qtcreator-edit-codestyle.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-edit-codestyle.png rename to contributing/development/configuring_an_ide/img/qtcreator-edit-codestyle.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-edit-files-menu.png b/contributing/development/configuring_an_ide/img/qtcreator-edit-files-menu.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-edit-files-menu.png rename to contributing/development/configuring_an_ide/img/qtcreator-edit-files-menu.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-new-project.png b/contributing/development/configuring_an_ide/img/qtcreator-new-project.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-new-project.png rename to contributing/development/configuring_an_ide/img/qtcreator-new-project.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-options-cpp.png b/contributing/development/configuring_an_ide/img/qtcreator-options-cpp.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-options-cpp.png rename to contributing/development/configuring_an_ide/img/qtcreator-options-cpp.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-project-name-includes.png b/contributing/development/configuring_an_ide/img/qtcreator-project-name-includes.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-project-name-includes.png rename to contributing/development/configuring_an_ide/img/qtcreator-project-name-includes.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-projects-build.png b/contributing/development/configuring_an_ide/img/qtcreator-projects-build.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-projects-build.png rename to contributing/development/configuring_an_ide/img/qtcreator-projects-build.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-run-command.png b/contributing/development/configuring_an_ide/img/qtcreator-run-command.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-run-command.png rename to contributing/development/configuring_an_ide/img/qtcreator-run-command.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-set-project-path.png b/contributing/development/configuring_an_ide/img/qtcreator-set-project-path.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-set-project-path.png rename to contributing/development/configuring_an_ide/img/qtcreator-set-project-path.png diff --git a/development/cpp/configuring_an_ide/img/qtcreator-set-scons-command.png b/contributing/development/configuring_an_ide/img/qtcreator-set-scons-command.png similarity index 100% rename from development/cpp/configuring_an_ide/img/qtcreator-set-scons-command.png rename to contributing/development/configuring_an_ide/img/qtcreator-set-scons-command.png diff --git a/development/cpp/configuring_an_ide/img/vs_1_install_cpp_package.png b/contributing/development/configuring_an_ide/img/vs_1_install_cpp_package.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vs_1_install_cpp_package.png rename to contributing/development/configuring_an_ide/img/vs_1_install_cpp_package.png diff --git a/development/cpp/configuring_an_ide/img/vs_2_project_properties.png b/contributing/development/configuring_an_ide/img/vs_2_project_properties.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vs_2_project_properties.png rename to contributing/development/configuring_an_ide/img/vs_2_project_properties.png diff --git a/development/cpp/configuring_an_ide/img/vs_3_debug_command_line.png b/contributing/development/configuring_an_ide/img/vs_3_debug_command_line.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vs_3_debug_command_line.png rename to contributing/development/configuring_an_ide/img/vs_3_debug_command_line.png diff --git a/development/cpp/configuring_an_ide/img/vs_4_debugging_main.png b/contributing/development/configuring_an_ide/img/vs_4_debugging_main.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vs_4_debugging_main.png rename to contributing/development/configuring_an_ide/img/vs_4_debugging_main.png diff --git a/development/cpp/configuring_an_ide/img/vscode_1_create_launch.json.png b/contributing/development/configuring_an_ide/img/vscode_1_create_launch.json.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vscode_1_create_launch.json.png rename to contributing/development/configuring_an_ide/img/vscode_1_create_launch.json.png diff --git a/development/cpp/configuring_an_ide/img/vscode_2_launch.json.png b/contributing/development/configuring_an_ide/img/vscode_2_launch.json.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vscode_2_launch.json.png rename to contributing/development/configuring_an_ide/img/vscode_2_launch.json.png diff --git a/development/cpp/configuring_an_ide/img/vscode_3_tasks.json.png b/contributing/development/configuring_an_ide/img/vscode_3_tasks.json.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vscode_3_tasks.json.png rename to contributing/development/configuring_an_ide/img/vscode_3_tasks.json.png diff --git a/development/cpp/configuring_an_ide/img/vscode_configure_task.png b/contributing/development/configuring_an_ide/img/vscode_configure_task.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vscode_configure_task.png rename to contributing/development/configuring_an_ide/img/vscode_configure_task.png diff --git a/development/cpp/configuring_an_ide/img/vscode_create_tasksjson.png b/contributing/development/configuring_an_ide/img/vscode_create_tasksjson.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vscode_create_tasksjson.png rename to contributing/development/configuring_an_ide/img/vscode_create_tasksjson.png diff --git a/development/cpp/configuring_an_ide/img/vscode_create_tasksjson_others.png b/contributing/development/configuring_an_ide/img/vscode_create_tasksjson_others.png similarity index 100% rename from development/cpp/configuring_an_ide/img/vscode_create_tasksjson_others.png rename to contributing/development/configuring_an_ide/img/vscode_create_tasksjson_others.png diff --git a/development/cpp/configuring_an_ide/img/xcode_1_create_external_build_project.png b/contributing/development/configuring_an_ide/img/xcode_1_create_external_build_project.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_1_create_external_build_project.png rename to contributing/development/configuring_an_ide/img/xcode_1_create_external_build_project.png diff --git a/development/cpp/configuring_an_ide/img/xcode_2_configure_scons.png b/contributing/development/configuring_an_ide/img/xcode_2_configure_scons.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_2_configure_scons.png rename to contributing/development/configuring_an_ide/img/xcode_2_configure_scons.png diff --git a/development/cpp/configuring_an_ide/img/xcode_3_add_new_target.png b/contributing/development/configuring_an_ide/img/xcode_3_add_new_target.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_3_add_new_target.png rename to contributing/development/configuring_an_ide/img/xcode_3_add_new_target.png diff --git a/development/cpp/configuring_an_ide/img/xcode_4_select_command_line_target.png b/contributing/development/configuring_an_ide/img/xcode_4_select_command_line_target.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_4_select_command_line_target.png rename to contributing/development/configuring_an_ide/img/xcode_4_select_command_line_target.png diff --git a/development/cpp/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png b/contributing/development/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png rename to contributing/development/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png diff --git a/development/cpp/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png b/contributing/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png rename to contributing/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png diff --git a/development/cpp/configuring_an_ide/img/xcode_7_setup_build_post_action.png b/contributing/development/configuring_an_ide/img/xcode_7_setup_build_post_action.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_7_setup_build_post_action.png rename to contributing/development/configuring_an_ide/img/xcode_7_setup_build_post_action.png diff --git a/development/cpp/configuring_an_ide/img/xcode_8_setup_run_scheme.png b/contributing/development/configuring_an_ide/img/xcode_8_setup_run_scheme.png similarity index 100% rename from development/cpp/configuring_an_ide/img/xcode_8_setup_run_scheme.png rename to contributing/development/configuring_an_ide/img/xcode_8_setup_run_scheme.png diff --git a/development/cpp/configuring_an_ide/index.rst b/contributing/development/configuring_an_ide/index.rst similarity index 100% rename from development/cpp/configuring_an_ide/index.rst rename to contributing/development/configuring_an_ide/index.rst diff --git a/development/cpp/configuring_an_ide/kdevelop.rst b/contributing/development/configuring_an_ide/kdevelop.rst similarity index 100% rename from development/cpp/configuring_an_ide/kdevelop.rst rename to contributing/development/configuring_an_ide/kdevelop.rst diff --git a/development/cpp/configuring_an_ide/qt_creator.rst b/contributing/development/configuring_an_ide/qt_creator.rst similarity index 100% rename from development/cpp/configuring_an_ide/qt_creator.rst rename to contributing/development/configuring_an_ide/qt_creator.rst diff --git a/development/cpp/configuring_an_ide/visual_studio.rst b/contributing/development/configuring_an_ide/visual_studio.rst similarity index 100% rename from development/cpp/configuring_an_ide/visual_studio.rst rename to contributing/development/configuring_an_ide/visual_studio.rst diff --git a/development/cpp/configuring_an_ide/visual_studio_code.rst b/contributing/development/configuring_an_ide/visual_studio_code.rst similarity index 100% rename from development/cpp/configuring_an_ide/visual_studio_code.rst rename to contributing/development/configuring_an_ide/visual_studio_code.rst diff --git a/development/cpp/configuring_an_ide/xcode.rst b/contributing/development/configuring_an_ide/xcode.rst similarity index 100% rename from development/cpp/configuring_an_ide/xcode.rst rename to contributing/development/configuring_an_ide/xcode.rst diff --git a/development/cpp/binding_to_external_libraries.rst b/contributing/development/core_and_modules/binding_to_external_libraries.rst similarity index 100% rename from development/cpp/binding_to_external_libraries.rst rename to contributing/development/core_and_modules/binding_to_external_libraries.rst diff --git a/development/cpp/common_engine_methods_and_macros.rst b/contributing/development/core_and_modules/common_engine_methods_and_macros.rst similarity index 100% rename from development/cpp/common_engine_methods_and_macros.rst rename to contributing/development/core_and_modules/common_engine_methods_and_macros.rst diff --git a/development/cpp/core_types.rst b/contributing/development/core_and_modules/core_types.rst similarity index 100% rename from development/cpp/core_types.rst rename to contributing/development/core_and_modules/core_types.rst diff --git a/development/cpp/custom_audiostreams.rst b/contributing/development/core_and_modules/custom_audiostreams.rst similarity index 100% rename from development/cpp/custom_audiostreams.rst rename to contributing/development/core_and_modules/custom_audiostreams.rst diff --git a/development/cpp/custom_godot_servers.rst b/contributing/development/core_and_modules/custom_godot_servers.rst similarity index 100% rename from development/cpp/custom_godot_servers.rst rename to contributing/development/core_and_modules/custom_godot_servers.rst diff --git a/development/cpp/custom_modules_in_cpp.rst b/contributing/development/core_and_modules/custom_modules_in_cpp.rst similarity index 99% rename from development/cpp/custom_modules_in_cpp.rst rename to contributing/development/core_and_modules/custom_modules_in_cpp.rst index bfbc76ffd..b9ccc0df5 100644 --- a/development/cpp/custom_modules_in_cpp.rst +++ b/contributing/development/core_and_modules/custom_modules_in_cpp.rst @@ -579,7 +579,7 @@ Now if you go to the ``godot/modules/summator/doc_classes`` folder, you will see that it contains a ``Summator.xml`` file, or any other classes, that you referenced in your ``get_doc_classes`` function. -Edit the file(s) following :ref:`doc_class_reference_writing_guidelines` and recompile the engine. +Edit the file(s) following :ref:`doc_class_reference_primer` and recompile the engine. Once the compilation process is finished, the docs will become accessible within the engine's built-in documentation system. diff --git a/development/cpp/custom_resource_format_loaders.rst b/contributing/development/core_and_modules/custom_resource_format_loaders.rst similarity index 100% rename from development/cpp/custom_resource_format_loaders.rst rename to contributing/development/core_and_modules/custom_resource_format_loaders.rst diff --git a/development/cpp/files/class_tree.zip b/contributing/development/core_and_modules/files/class_tree.zip similarity index 100% rename from development/cpp/files/class_tree.zip rename to contributing/development/core_and_modules/files/class_tree.zip diff --git a/development/cpp/img/Control.png b/contributing/development/core_and_modules/img/Control.png similarity index 100% rename from development/cpp/img/Control.png rename to contributing/development/core_and_modules/img/Control.png diff --git a/development/cpp/img/Node2D.png b/contributing/development/core_and_modules/img/Node2D.png similarity index 100% rename from development/cpp/img/Node2D.png rename to contributing/development/core_and_modules/img/Node2D.png diff --git a/development/cpp/img/Object.png b/contributing/development/core_and_modules/img/Object.png similarity index 100% rename from development/cpp/img/Object.png rename to contributing/development/core_and_modules/img/Object.png diff --git a/development/cpp/img/Reference.png b/contributing/development/core_and_modules/img/Reference.png similarity index 100% rename from development/cpp/img/Reference.png rename to contributing/development/core_and_modules/img/Reference.png diff --git a/development/cpp/img/Spatial.png b/contributing/development/core_and_modules/img/Spatial.png similarity index 100% rename from development/cpp/img/Spatial.png rename to contributing/development/core_and_modules/img/Spatial.png diff --git a/development/cpp/img/architecture_diagram.jpg b/contributing/development/core_and_modules/img/architecture_diagram.jpg similarity index 100% rename from development/cpp/img/architecture_diagram.jpg rename to contributing/development/core_and_modules/img/architecture_diagram.jpg diff --git a/development/cpp/index.rst b/contributing/development/core_and_modules/index.rst similarity index 54% rename from development/cpp/index.rst rename to contributing/development/core_and_modules/index.rst index f730696a5..b5bacd047 100644 --- a/development/cpp/index.rst +++ b/contributing/development/core_and_modules/index.rst @@ -1,16 +1,5 @@ -Engine development -================== - -Setting up a development environment ------------------------------------- - -To modify Godot's source code, you need to set up a development environment. Start here. - -.. toctree:: - :maxdepth: 1 - :name: toc-devel-cpp-dev-env - - configuring_an_ide/index +Engine core and modules +======================= Getting started with Godot's source code ---------------------------------------- @@ -29,7 +18,7 @@ This section covers the basics that you will encounter in (almost) every source inheritance_class_tree Extending Godot by modifying its source code ---------------------------------------------- +-------------------------------------------- This section covers what you can do by modifying Godot's C++ source code. @@ -43,16 +32,3 @@ This section covers what you can do by modifying Godot's C++ source code. custom_resource_format_loaders custom_audiostreams unit_testing - -Debugging and profiling ------------------------ - -This section is about finding spots to optimize in the engine code when you need it in your project. - -.. toctree:: - :maxdepth: 1 - :name: toc-devel-cpp-debug-profiling - - macos_debug - using_cpp_profilers - vulkan/index diff --git a/development/cpp/inheritance_class_tree.rst b/contributing/development/core_and_modules/inheritance_class_tree.rst similarity index 100% rename from development/cpp/inheritance_class_tree.rst rename to contributing/development/core_and_modules/inheritance_class_tree.rst diff --git a/development/cpp/introduction_to_godot_development.rst b/contributing/development/core_and_modules/introduction_to_godot_development.rst similarity index 100% rename from development/cpp/introduction_to_godot_development.rst rename to contributing/development/core_and_modules/introduction_to_godot_development.rst diff --git a/development/cpp/object_class.rst b/contributing/development/core_and_modules/object_class.rst similarity index 100% rename from development/cpp/object_class.rst rename to contributing/development/core_and_modules/object_class.rst diff --git a/development/cpp/unit_testing.rst b/contributing/development/core_and_modules/unit_testing.rst similarity index 100% rename from development/cpp/unit_testing.rst rename to contributing/development/core_and_modules/unit_testing.rst diff --git a/development/cpp/variant_class.rst b/contributing/development/core_and_modules/variant_class.rst similarity index 100% rename from development/cpp/variant_class.rst rename to contributing/development/core_and_modules/variant_class.rst diff --git a/community/contributing/cpp_usage_guidelines.rst b/contributing/development/cpp_usage_guidelines.rst similarity index 100% rename from community/contributing/cpp_usage_guidelines.rst rename to contributing/development/cpp_usage_guidelines.rst diff --git a/development/cpp/img/cpp_profiler_hotspot_flame_graph.png b/contributing/development/debugging/img/cpp_profiler_hotspot_flame_graph.png similarity index 100% rename from development/cpp/img/cpp_profiler_hotspot_flame_graph.png rename to contributing/development/debugging/img/cpp_profiler_hotspot_flame_graph.png diff --git a/development/cpp/img/cpp_profiler_hotspot_record.png b/contributing/development/debugging/img/cpp_profiler_hotspot_record.png similarity index 100% rename from development/cpp/img/cpp_profiler_hotspot_record.png rename to contributing/development/debugging/img/cpp_profiler_hotspot_record.png diff --git a/development/cpp/img/cpp_profiler_hotspot_view_results.png b/contributing/development/debugging/img/cpp_profiler_hotspot_view_results.png similarity index 100% rename from development/cpp/img/cpp_profiler_hotspot_view_results.png rename to contributing/development/debugging/img/cpp_profiler_hotspot_view_results.png diff --git a/development/cpp/img/cpp_profiler_hotspot_welcome.png b/contributing/development/debugging/img/cpp_profiler_hotspot_welcome.png similarity index 100% rename from development/cpp/img/cpp_profiler_hotspot_welcome.png rename to contributing/development/debugging/img/cpp_profiler_hotspot_welcome.png diff --git a/development/cpp/img/cpp_profiler_time_profiler.png b/contributing/development/debugging/img/cpp_profiler_time_profiler.png similarity index 100% rename from development/cpp/img/cpp_profiler_time_profiler.png rename to contributing/development/debugging/img/cpp_profiler_time_profiler.png diff --git a/development/cpp/img/cpp_profiler_time_profiler_record.png b/contributing/development/debugging/img/cpp_profiler_time_profiler_record.png similarity index 100% rename from development/cpp/img/cpp_profiler_time_profiler_record.png rename to contributing/development/debugging/img/cpp_profiler_time_profiler_record.png diff --git a/development/cpp/img/cpp_profiler_time_profiler_result.png b/contributing/development/debugging/img/cpp_profiler_time_profiler_result.png similarity index 100% rename from development/cpp/img/cpp_profiler_time_profiler_result.png rename to contributing/development/debugging/img/cpp_profiler_time_profiler_result.png diff --git a/development/cpp/img/cpp_profiler_verysleepy_results_filtered.png b/contributing/development/debugging/img/cpp_profiler_verysleepy_results_filtered.png similarity index 100% rename from development/cpp/img/cpp_profiler_verysleepy_results_filtered.png rename to contributing/development/debugging/img/cpp_profiler_verysleepy_results_filtered.png diff --git a/development/cpp/img/cpp_profiler_verysleepy_select_process.png b/contributing/development/debugging/img/cpp_profiler_verysleepy_select_process.png similarity index 100% rename from development/cpp/img/cpp_profiler_verysleepy_select_process.png rename to contributing/development/debugging/img/cpp_profiler_verysleepy_select_process.png diff --git a/development/cpp/img/cpp_profiler_xcode_menu.png b/contributing/development/debugging/img/cpp_profiler_xcode_menu.png similarity index 100% rename from development/cpp/img/cpp_profiler_xcode_menu.png rename to contributing/development/debugging/img/cpp_profiler_xcode_menu.png diff --git a/contributing/development/debugging/index.rst b/contributing/development/debugging/index.rst new file mode 100644 index 000000000..823636215 --- /dev/null +++ b/contributing/development/debugging/index.rst @@ -0,0 +1,12 @@ +Debugging and profiling +======================= + +This section is about finding spots to optimize in the engine code when you need it in your project. + +.. toctree:: + :maxdepth: 1 + :name: toc-devel-cpp-debug-profiling + + macos_debug + using_cpp_profilers + vulkan/index diff --git a/development/cpp/macos_debug.rst b/contributing/development/debugging/macos_debug.rst similarity index 100% rename from development/cpp/macos_debug.rst rename to contributing/development/debugging/macos_debug.rst diff --git a/development/cpp/using_cpp_profilers.rst b/contributing/development/debugging/using_cpp_profilers.rst similarity index 100% rename from development/cpp/using_cpp_profilers.rst rename to contributing/development/debugging/using_cpp_profilers.rst diff --git a/development/cpp/vulkan/index.rst b/contributing/development/debugging/vulkan/index.rst similarity index 100% rename from development/cpp/vulkan/index.rst rename to contributing/development/debugging/vulkan/index.rst diff --git a/development/cpp/vulkan/vulkan_validation_layers.rst b/contributing/development/debugging/vulkan/vulkan_validation_layers.rst similarity index 100% rename from development/cpp/vulkan/vulkan_validation_layers.rst rename to contributing/development/debugging/vulkan/vulkan_validation_layers.rst diff --git a/development/editor/creating_icons.rst b/contributing/development/editor/creating_icons.rst similarity index 100% rename from development/editor/creating_icons.rst rename to contributing/development/editor/creating_icons.rst diff --git a/development/editor/editor_style_guide.rst b/contributing/development/editor/editor_style_guide.rst similarity index 100% rename from development/editor/editor_style_guide.rst rename to contributing/development/editor/editor_style_guide.rst diff --git a/development/editor/index.rst b/contributing/development/editor/index.rst similarity index 100% rename from development/editor/index.rst rename to contributing/development/editor/index.rst diff --git a/development/editor/introduction_to_editor_development.rst b/contributing/development/editor/introduction_to_editor_development.rst similarity index 100% rename from development/editor/introduction_to_editor_development.rst rename to contributing/development/editor/introduction_to_editor_development.rst diff --git a/development/file_formats/gdscript_grammar.rst b/contributing/development/file_formats/gdscript_grammar.rst similarity index 100% rename from development/file_formats/gdscript_grammar.rst rename to contributing/development/file_formats/gdscript_grammar.rst diff --git a/development/file_formats/index.rst b/contributing/development/file_formats/index.rst similarity index 100% rename from development/file_formats/index.rst rename to contributing/development/file_formats/index.rst diff --git a/development/file_formats/tscn.rst b/contributing/development/file_formats/tscn.rst similarity index 100% rename from development/file_formats/tscn.rst rename to contributing/development/file_formats/tscn.rst diff --git a/community/contributing/img/best_practices1.png b/contributing/development/img/best_practices1.png similarity index 100% rename from community/contributing/img/best_practices1.png rename to contributing/development/img/best_practices1.png diff --git a/community/contributing/img/best_practices2.png b/contributing/development/img/best_practices2.png similarity index 100% rename from community/contributing/img/best_practices2.png rename to contributing/development/img/best_practices2.png diff --git a/community/contributing/img/best_practices3.png b/contributing/development/img/best_practices3.png similarity index 100% rename from community/contributing/img/best_practices3.png rename to contributing/development/img/best_practices3.png diff --git a/community/contributing/img/best_practices4.png b/contributing/development/img/best_practices4.png similarity index 100% rename from community/contributing/img/best_practices4.png rename to contributing/development/img/best_practices4.png diff --git a/community/contributing/img/best_practices5.png b/contributing/development/img/best_practices5.png similarity index 100% rename from community/contributing/img/best_practices5.png rename to contributing/development/img/best_practices5.png diff --git a/community/contributing/img/best_practices6.png b/contributing/development/img/best_practices6.png similarity index 100% rename from community/contributing/img/best_practices6.png rename to contributing/development/img/best_practices6.png diff --git a/community/contributing/img/best_practices7.png b/contributing/development/img/best_practices7.png similarity index 100% rename from community/contributing/img/best_practices7.png rename to contributing/development/img/best_practices7.png diff --git a/community/contributing/img/best_practices8.png b/contributing/development/img/best_practices8.png similarity index 100% rename from community/contributing/img/best_practices8.png rename to contributing/development/img/best_practices8.png diff --git a/contributing/development/index.rst b/contributing/development/index.rst new file mode 100644 index 000000000..21d058660 --- /dev/null +++ b/contributing/development/index.rst @@ -0,0 +1,25 @@ +.. _doc_contributing_to_the_engine: + +Engine development +================== + +The guides below explain how to contribute to the engine's codebase. You will learn +about best practices when working on solutions and features, the code style and the +internal structure of the codebase, how to set up your working environment, and more. + +Be sure to also check the :ref:`workflow guidelines `, +especially if you're new to using Git or GitHub. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-to-the-engine + + best_practices_for_engine_contributors + code_style_guidelines + cpp_usage_guidelines + compiling/index + debugging/index + configuring_an_ide/index + core_and_modules/index + editor/index + file_formats/index diff --git a/community/contributing/building_the_manual.rst b/contributing/documentation/building_the_manual.rst similarity index 100% rename from community/contributing/building_the_manual.rst rename to contributing/documentation/building_the_manual.rst diff --git a/community/contributing/class_reference_writing_guidelines.rst b/contributing/documentation/class_reference_primer.rst similarity index 96% rename from community/contributing/class_reference_writing_guidelines.rst rename to contributing/documentation/class_reference_primer.rst index 21b44ccec..29f789479 100644 --- a/community/contributing/class_reference_writing_guidelines.rst +++ b/contributing/documentation/class_reference_primer.rst @@ -1,7 +1,7 @@ -.. _doc_class_reference_writing_guidelines: +.. _doc_class_reference_primer: -Class reference writing guidelines -================================== +Class reference primer +====================== This page explains how to write the class reference. You will learn where to write new descriptions for the classes, methods, and properties for Godot's @@ -84,7 +84,7 @@ Write in a clear and simple language. Always follow the :ref:`writing guidelines **Do not leave empty lines** in the descriptions: each line in the XML file will result in a new paragraph, even if it is empty. -.. _doc_class_reference_writing_guidelines_editing_xml: +.. _doc_class_reference_editing_xml: How to edit class XML --------------------- @@ -120,7 +120,7 @@ search feature to find classes and properties quickly. `vscode-xml extension `__ to get linting for class reference XML files. -.. _doc_class_reference_writing_guidelines_bbcode: +.. _doc_class_reference_bbcode: Improve formatting with BBCode style tags ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -273,13 +273,3 @@ Notice the use of italics instead of bold: In all the paragraphs described above, make sure the punctuation is part of the BBCode tags for consistency. - -I don't know what this method does! -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -No problem. Leave it for now, and list the methods you skipped when you -open a Pull Request with your changes. Another writer will take care of it. - -You can still look at the methods' implementation in Godot's source code on -GitHub. If you have doubts, feel free to ask on the `Q&A website -`__ and `Godot Contributors Chat `_. diff --git a/community/contributing/content_guidelines.rst b/contributing/documentation/content_guidelines.rst similarity index 100% rename from community/contributing/content_guidelines.rst rename to contributing/documentation/content_guidelines.rst diff --git a/community/contributing/contributing_to_the_documentation.rst b/contributing/documentation/contributing_to_the_documentation.rst similarity index 97% rename from community/contributing/contributing_to_the_documentation.rst rename to contributing/documentation/contributing_to_the_documentation.rst index cbae0374e..91b886785 100644 --- a/community/contributing/contributing_to_the_documentation.rst +++ b/contributing/documentation/contributing_to_the_documentation.rst @@ -41,9 +41,9 @@ two game creation tutorials in the Getting Started section. We strive to write factual content in an accessible and well-written language. To contribute, you should also read: -1. The :ref:`doc_docs_writing_guidelines`. There, you will find rules and +1. :ref:`doc_docs_writing_guidelines`. There, you will find rules and recommendations to write in a way that everyone understands. -2. The content guidelines. They explain the principles we follow to write the +2. :ref:`doc_content_guidelines`. They explain the principles we follow to write the documentation and the kind of content we accept. Contributing changes diff --git a/community/contributing/docs_writing_guidelines.rst b/contributing/documentation/docs_writing_guidelines.rst similarity index 99% rename from community/contributing/docs_writing_guidelines.rst rename to contributing/documentation/docs_writing_guidelines.rst index 4ffd4170d..fee329e50 100644 --- a/community/contributing/docs_writing_guidelines.rst +++ b/contributing/documentation/docs_writing_guidelines.rst @@ -1,7 +1,7 @@ .. _doc_docs_writing_guidelines: -Docs writing guidelines -======================= +Writing guidelines +================== The Godot community is rich and international. Users come from all around the world. Some of them are young, and many aren't native English diff --git a/community/contributing/editor_and_docs_localization.rst b/contributing/documentation/editor_and_docs_localization.rst similarity index 99% rename from community/contributing/editor_and_docs_localization.rst rename to contributing/documentation/editor_and_docs_localization.rst index d97c4b471..05492e019 100644 --- a/community/contributing/editor_and_docs_localization.rst +++ b/contributing/documentation/editor_and_docs_localization.rst @@ -1,7 +1,7 @@ .. _doc_editor_and_docs_localization: -Editor and docs localization -============================ +Editor and documentation localization +===================================== .. highlight:: none @@ -328,7 +328,7 @@ breaks if they are not part of the original translation. .. seealso:: See our documentation for class reference writers for the :ref:`list of - BBCode-like tags ` which are used + BBCode-like tags ` which are used throughout the class reference. Offline translation and testing diff --git a/community/contributing/img/editor-vocabulary-overview.png b/contributing/documentation/img/editor-vocabulary-overview.png similarity index 100% rename from community/contributing/img/editor-vocabulary-overview.png rename to contributing/documentation/img/editor-vocabulary-overview.png diff --git a/community/contributing/img/l10n_01_language_list.png b/contributing/documentation/img/l10n_01_language_list.png similarity index 100% rename from community/contributing/img/l10n_01_language_list.png rename to contributing/documentation/img/l10n_01_language_list.png diff --git a/community/contributing/img/l10n_02_new_translation.png b/contributing/documentation/img/l10n_02_new_translation.png similarity index 100% rename from community/contributing/img/l10n_02_new_translation.png rename to contributing/documentation/img/l10n_02_new_translation.png diff --git a/community/contributing/img/l10n_03_translation_overview.png b/contributing/documentation/img/l10n_03_translation_overview.png similarity index 100% rename from community/contributing/img/l10n_03_translation_overview.png rename to contributing/documentation/img/l10n_03_translation_overview.png diff --git a/community/contributing/img/l10n_04_translation_interface.png b/contributing/documentation/img/l10n_04_translation_interface.png similarity index 100% rename from community/contributing/img/l10n_04_translation_interface.png rename to contributing/documentation/img/l10n_04_translation_interface.png diff --git a/community/contributing/img/l10n_05_search_location.png b/contributing/documentation/img/l10n_05_search_location.png similarity index 100% rename from community/contributing/img/l10n_05_search_location.png rename to contributing/documentation/img/l10n_05_search_location.png diff --git a/community/contributing/img/l10n_06_browse_by_location.png b/contributing/documentation/img/l10n_06_browse_by_location.png similarity index 100% rename from community/contributing/img/l10n_06_browse_by_location.png rename to contributing/documentation/img/l10n_06_browse_by_location.png diff --git a/community/contributing/img/l10n_07_download_po_file.png b/contributing/documentation/img/l10n_07_download_po_file.png similarity index 100% rename from community/contributing/img/l10n_07_download_po_file.png rename to contributing/documentation/img/l10n_07_download_po_file.png diff --git a/community/contributing/img/l10n_08_edit_on_github.png b/contributing/documentation/img/l10n_08_edit_on_github.png similarity index 100% rename from community/contributing/img/l10n_08_edit_on_github.png rename to contributing/documentation/img/l10n_08_edit_on_github.png diff --git a/community/contributing/img/l10n_09_path_to_image.png b/contributing/documentation/img/l10n_09_path_to_image.png similarity index 100% rename from community/contributing/img/l10n_09_path_to_image.png rename to contributing/documentation/img/l10n_09_path_to_image.png diff --git a/contributing/documentation/index.rst b/contributing/documentation/index.rst new file mode 100644 index 000000000..a9ec1ec8e --- /dev/null +++ b/contributing/documentation/index.rst @@ -0,0 +1,67 @@ +.. _doc_contributing_writing_documentation: + +Writing documentation +===================== + +We always need help to improve the documentation, be it the class reference or +the manual. Below, you can find our content and writing guidelines and +concrete guides to make changes to the documentation. + +Be sure to also check the :ref:`workflow guidelines `, +especially if you're new to using Git or GitHub. + +Guidelines +---------- + +Here are the principles and guidelines we strive to follow to write accessible +documentation. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-writing-guidelines + + content_guidelines + docs_writing_guidelines + +Writing the manual +------------------ + +These articles explain how to contribute to this very documentation, and +how to build the online version locally for testing. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-documentation + + contributing_to_the_documentation + building_the_manual + +Class reference guides +---------------------- + +The pages below focus on the class reference. + +As the reference is included in the Godot editor, its source files are part of +the `godot repository `_. We use XML files +to write it, so the process to contribute to the class reference differs from +writing the online manual. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-class-reference + + updating_the_class_reference + class_reference_primer + +Translating the documentation +----------------------------- + +The community is always working hard on making Godot and its documentation +available to more people. Localizing the documentation is a colossal and ongoing +effort you can be part of. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-localization + + editor_and_docs_localization diff --git a/contributing/documentation/updating_the_class_reference.rst b/contributing/documentation/updating_the_class_reference.rst new file mode 100644 index 000000000..c8036e11d --- /dev/null +++ b/contributing/documentation/updating_the_class_reference.rst @@ -0,0 +1,112 @@ +.. _doc_updating_the_class_reference: + +Contributing to the class reference +=================================== + +.. highlight:: shell + +The :ref:`Class reference ` is a set of articles describing +the public API of the engine. This includes descriptions for various classes, +methods, properties, and global objects, available for scripting. The class reference +is available online, from the documentation sidebar, and in the Godot editor, from +the help menu. + +As the engine grows and features are added or modified, some parts of the class reference +become obsolete and new descriptions and examples need to be added. While developers are +encouraged to document all of their work in the class reference when submitting a pull request, +we can't expect everyone to be able to write high quality documentation, so there is +always work for contributors like you to polish existing and create missing reference material. + +The source of the class reference +--------------------------------- + +As the class reference is available in two places, online and in the editor, we need to +take care to keep things in sync. To achieve this the `main Godot repository `_ +is picked as the source of truth, and the documentation for the class reference is tracked there. + +.. warning:: + + You should **not** edit ``.rst`` files in the ``classes/`` folder of the + `documentation repository `_. + These files are generated automatically and are synced manually by project + maintainers. Read further to learn how to correctly edit the class reference. + +In the main repository the class reference is stored in XML files, one for each exposed +class or global object. The majority of these files is located in `doc/classes/ +`_, but some modules +contain their own documentation as well. You will find it in the ``modules//doc_classes/`` +directory. To learn more about editing XML files refer to :ref:`doc_class_reference_primer`. + +.. seealso:: + + For details on Git usage and the pull request workflow, please + refer to the :ref:`doc_pr_workflow` page. + + If you want to translate the class reference from English to another + language, see :ref:`doc_editor_and_docs_localization`. This guide is + also available as a `video tutorial on YouTube + `_. + +**Important:** If you plan to make large changes, you should create an issue on +the `godot-docs repository `_ +or comment on an existing issue. Doing so lets others know you're already +taking care of a given class. + +What to contribute +------------------ + +The natural place to start contributing is the classes that you are most familiar with. +This ensures that the added description will be based on experience and the necessary +know-how, not just the name of a method or a property. We advise not to add low effort +descriptions, no matter how appealing it may look. Such descriptions obscure the need +for documentation and are hard to identify automatically. + +.. seealso:: + + Following this principle is important and allows us to create tools for contributors. + Such as the class reference's `completion status tracker `_. + You can use it to quickly find documentation pages missing descriptions. + +If you decide to document a class, but don't know what a particular method does, don't +worry. Leave it for now, and list the methods you skipped when you open a pull request +with your changes. Another writer will take care of it. + +You can still look at the methods' implementation in Godot's source code on GitHub. +If you have doubts, feel free to ask on the `Q&A website `_ +and `Godot Contributors Chat `_. + +.. warning:: + + Unless you make minor changes, like fixing a typo, we do not recommend using the + GitHub web editor to edit the class reference's XML files. It lacks features to edit + XML well, like keeping indentations consistent, and it does not allow amending commits + based on reviews. + + It also doesn't allow you to test your changes in the engine or with validation + scripts as described in :ref:`doc_class_reference_editing_xml`. + + +Updating class reference when working on the engine +--------------------------------------------------- + +When you create a new class or modify an existing engine's API, you need to re-generate +the XML files in ``doc/classes/``. + +To do so, you first need to compile Godot. See the :ref:`doc_introduction_to_the_buildsystem` +page to learn how. Then, execute the compiled Godot binary from the Godot root directory +with the ``--doctool`` option. For example, if you're on 64-bit Linux, the command might be: + +:: + + ./bin/godot.linuxbsd.editor.x86_64 --doctool + +The exact set of suffixes may be different. Carefully read through the linked article to +learn more about that. + +The XML files in ``doc/classes/`` should then be up-to-date with current Godot Engine +features. You can then check what changed using the ``git diff`` command. + +Please only include changes that are relevant to your work on the API in your commits. +You can discard changes in other XML files using ``git checkout``, but consider reporting +if you notice unrelated files being updated. Ideally, running this command should only +bring up the changes that you yourself have made. diff --git a/community/contributing/ways_to_contribute.rst b/contributing/ways_to_contribute.rst similarity index 99% rename from community/contributing/ways_to_contribute.rst rename to contributing/ways_to_contribute.rst index 46aff9c00..e8e44e83f 100644 --- a/community/contributing/ways_to_contribute.rst +++ b/contributing/ways_to_contribute.rst @@ -199,8 +199,8 @@ There are two separate resources referred to as "documentation" in Godot: offline, directly in Godot's code editor, or online at Godot :ref:`Class Reference `. To contribute to the class reference, you have to edit the XML file corresponding to the class and make a pull request. - See :ref:`doc_updating_the_class_reference` and - :ref:`doc_class_reference_writing_guidelines` for more details. + See :ref:`doc_updating_the_class_reference` and :ref:`doc_class_reference_primer` + for more details. - **The tutorials and engine documentation and its translations.** This is the part you are reading now, which is distributed in the HTML format. diff --git a/community/contributing/bisecting_regressions.rst b/contributing/workflow/bisecting_regressions.rst similarity index 100% rename from community/contributing/bisecting_regressions.rst rename to contributing/workflow/bisecting_regressions.rst diff --git a/community/contributing/bug_triage_guidelines.rst b/contributing/workflow/bug_triage_guidelines.rst similarity index 100% rename from community/contributing/bug_triage_guidelines.rst rename to contributing/workflow/bug_triage_guidelines.rst diff --git a/community/contributing/img/github_fork_button.png b/contributing/workflow/img/github_fork_button.png similarity index 100% rename from community/contributing/img/github_fork_button.png rename to contributing/workflow/img/github_fork_button.png diff --git a/community/contributing/img/github_fork_make_pr.png b/contributing/workflow/img/github_fork_make_pr.png similarity index 100% rename from community/contributing/img/github_fork_make_pr.png rename to contributing/workflow/img/github_fork_make_pr.png diff --git a/community/contributing/img/github_fork_url.png b/contributing/workflow/img/github_fork_url.png similarity index 100% rename from community/contributing/img/github_fork_url.png rename to contributing/workflow/img/github_fork_url.png diff --git a/community/contributing/img/testing_pull_requests_access_checks.png b/contributing/workflow/img/testing_pull_requests_access_checks.png similarity index 100% rename from community/contributing/img/testing_pull_requests_access_checks.png rename to contributing/workflow/img/testing_pull_requests_access_checks.png diff --git a/community/contributing/img/testing_pull_requests_access_fork.png b/contributing/workflow/img/testing_pull_requests_access_fork.png similarity index 100% rename from community/contributing/img/testing_pull_requests_access_fork.png rename to contributing/workflow/img/testing_pull_requests_access_fork.png diff --git a/community/contributing/img/testing_pull_requests_checks_artifacts.png b/contributing/workflow/img/testing_pull_requests_checks_artifacts.png similarity index 100% rename from community/contributing/img/testing_pull_requests_checks_artifacts.png rename to contributing/workflow/img/testing_pull_requests_checks_artifacts.png diff --git a/community/contributing/img/testing_pull_requests_checks_platforms.png b/contributing/workflow/img/testing_pull_requests_checks_platforms.png similarity index 100% rename from community/contributing/img/testing_pull_requests_checks_platforms.png rename to contributing/workflow/img/testing_pull_requests_checks_platforms.png diff --git a/community/contributing/img/testing_pull_requests_fork_zip.png b/contributing/workflow/img/testing_pull_requests_fork_zip.png similarity index 100% rename from community/contributing/img/testing_pull_requests_fork_zip.png rename to contributing/workflow/img/testing_pull_requests_fork_zip.png diff --git a/community/contributing/img/testing_pull_requests_nightly_link.png b/contributing/workflow/img/testing_pull_requests_nightly_link.png similarity index 100% rename from community/contributing/img/testing_pull_requests_nightly_link.png rename to contributing/workflow/img/testing_pull_requests_nightly_link.png diff --git a/contributing/workflow/index.rst b/contributing/workflow/index.rst new file mode 100644 index 000000000..81934df4f --- /dev/null +++ b/contributing/workflow/index.rst @@ -0,0 +1,18 @@ +.. _doc_contributing_workflow: + +Contribution workflow +===================== + +Godot is a large project, both in terms of the codebase and the workload for +contributors. The guides below serve as a helper when you get stuck dealing +with Git or GitHub, or if you are generally interested in how maintainers +approach the project. + +.. toctree:: + :maxdepth: 1 + :name: toc-contributing-workflow + + bisecting_regressions + bug_triage_guidelines + pr_workflow + testing_pull_requests diff --git a/community/contributing/pr_workflow.rst b/contributing/workflow/pr_workflow.rst similarity index 100% rename from community/contributing/pr_workflow.rst rename to contributing/workflow/pr_workflow.rst diff --git a/community/contributing/testing_pull_requests.rst b/contributing/workflow/testing_pull_requests.rst similarity index 100% rename from community/contributing/testing_pull_requests.rst rename to contributing/workflow/testing_pull_requests.rst diff --git a/index.rst b/index.rst index 2d0bcabc5..b574f4a1c 100644 --- a/index.rst +++ b/index.rst @@ -134,13 +134,13 @@ the top-level ``index.html`` in a web browser. .. toctree:: :hidden: :maxdepth: 1 - :caption: Engine Development - :name: sec-devel + :caption: Contributing + :name: sec-contributing - development/compiling/index - development/cpp/index - development/editor/index - development/file_formats/index + contributing/ways_to_contribute + contributing/workflow/index + contributing/development/index + contributing/documentation/index .. toctree:: @@ -149,7 +149,6 @@ the top-level ``index.html`` in a web browser. :caption: Community :name: sec-community - community/contributing/index community/asset_library/index community/channels community/tutorials diff --git a/tutorials/ui/bbcode_in_richtextlabel.rst b/tutorials/ui/bbcode_in_richtextlabel.rst index 328963766..f25329e6b 100644 --- a/tutorials/ui/bbcode_in_richtextlabel.rst +++ b/tutorials/ui/bbcode_in_richtextlabel.rst @@ -17,7 +17,7 @@ formatting rules for a part of the text. You may be familiar with them if you ev forums (also known as `bulletin boards`, hence the "BB" in "BBCode"). Note that the BBCode tags can also be used, to some extent, in the XML source of -the class reference. For more information, see :ref:`doc_class_reference_writing_guidelines`. +the class reference. For more information, see :ref:`doc_class_reference_primer`. Using BBCode ------------