Browse Source

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.
Yuri Sizov 2 years ago
parent
commit
dbfe3b1d26
100 changed files with 73 additions and 193 deletions
  1. 63 0
      _tools/redirects/redirects.csv
  2. 8 7
      about/introduction.rst
  3. 0 108
      community/contributing/index.rst
  4. 0 76
      community/contributing/updating_the_class_reference.rst
  5. 0 0
      contributing/development/best_practices_for_engine_contributors.rst
  6. 0 0
      contributing/development/code_style_guidelines.rst
  7. 0 0
      contributing/development/compiling/compiling_for_android.rst
  8. 0 0
      contributing/development/compiling/compiling_for_ios.rst
  9. 0 0
      contributing/development/compiling/compiling_for_linuxbsd.rst
  10. 0 0
      contributing/development/compiling/compiling_for_macos.rst
  11. 0 0
      contributing/development/compiling/compiling_for_uwp.rst
  12. 0 0
      contributing/development/compiling/compiling_for_web.rst
  13. 0 0
      contributing/development/compiling/compiling_for_windows.rst
  14. 0 0
      contributing/development/compiling/compiling_with_mono.rst
  15. 0 0
      contributing/development/compiling/compiling_with_script_encryption_key.rst
  16. 0 0
      contributing/development/compiling/cross-compiling_for_ios_on_linux.rst
  17. 0 0
      contributing/development/compiling/getting_source.rst
  18. 0 0
      contributing/development/compiling/img/andtemplates.png
  19. 0 0
      contributing/development/compiling/img/encryption_key.png
  20. 0 0
      contributing/development/compiling/img/lintemplates.png
  21. 0 0
      contributing/development/compiling/img/wintemplates.png
  22. 2 2
      contributing/development/compiling/index.rst
  23. 0 0
      contributing/development/compiling/introduction_to_the_buildsystem.rst
  24. 0 0
      contributing/development/compiling/optimizing_for_size.rst
  25. 0 0
      contributing/development/configuring_an_ide/android_studio.rst
  26. 0 0
      contributing/development/configuring_an_ide/clion.rst
  27. 0 0
      contributing/development/configuring_an_ide/code_blocks.rst
  28. 0 0
      contributing/development/configuring_an_ide/img/android_studio_setup_project_1.png
  29. 0 0
      contributing/development/configuring_an_ide/img/clion-add-configuration.png
  30. 0 0
      contributing/development/configuring_an_ide/img/clion-add-custom-build-application.png
  31. 0 0
      contributing/development/configuring_an_ide/img/clion-build-run.png
  32. 0 0
      contributing/development/configuring_an_ide/img/clion-create-build-tool.png
  33. 0 0
      contributing/development/configuring_an_ide/img/clion-create-clean-tool.png
  34. 0 0
      contributing/development/configuring_an_ide/img/clion-external-tools.png
  35. 0 0
      contributing/development/configuring_an_ide/img/clion-preferences.png
  36. 0 0
      contributing/development/configuring_an_ide/img/clion-run-configuration.png
  37. 0 0
      contributing/development/configuring_an_ide/img/clion-select-tools.png
  38. 0 0
      contributing/development/configuring_an_ide/img/clion-target.png
  39. 0 0
      contributing/development/configuring_an_ide/img/code_block_use_tab_character.png
  40. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_add_files_recursively.png
  41. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_build_targets.png
  42. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png
  43. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_file_new_project.png
  44. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_new_empty_project.png
  45. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_open_build_options.png
  46. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_open_properties.png
  47. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_project_properties.png
  48. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_project_title_and_location.png
  49. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_scons_clean.png
  50. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_scons_minimum.png
  51. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_scons_windows.png
  52. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_select_files.png
  53. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_update_editor_settings.png
  54. 0 0
      contributing/development/configuring_an_ide/img/code_blocks_wizard_welcome.png
  55. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_addincludes.png
  56. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_buildconfig.png
  57. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_configlaunches.png
  58. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.png
  59. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_custombuild.png
  60. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_newproject.png
  61. 0 0
      contributing/development/configuring_an_ide/img/kdevelop_openconfig.png
  62. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-apply-import-filter.png
  63. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-edit-codestyle.png
  64. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-edit-files-menu.png
  65. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-new-project.png
  66. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-options-cpp.png
  67. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-project-name-includes.png
  68. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-projects-build.png
  69. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-run-command.png
  70. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-set-project-path.png
  71. 0 0
      contributing/development/configuring_an_ide/img/qtcreator-set-scons-command.png
  72. 0 0
      contributing/development/configuring_an_ide/img/vs_1_install_cpp_package.png
  73. 0 0
      contributing/development/configuring_an_ide/img/vs_2_project_properties.png
  74. 0 0
      contributing/development/configuring_an_ide/img/vs_3_debug_command_line.png
  75. 0 0
      contributing/development/configuring_an_ide/img/vs_4_debugging_main.png
  76. 0 0
      contributing/development/configuring_an_ide/img/vscode_1_create_launch.json.png
  77. 0 0
      contributing/development/configuring_an_ide/img/vscode_2_launch.json.png
  78. 0 0
      contributing/development/configuring_an_ide/img/vscode_3_tasks.json.png
  79. 0 0
      contributing/development/configuring_an_ide/img/vscode_configure_task.png
  80. 0 0
      contributing/development/configuring_an_ide/img/vscode_create_tasksjson.png
  81. 0 0
      contributing/development/configuring_an_ide/img/vscode_create_tasksjson_others.png
  82. 0 0
      contributing/development/configuring_an_ide/img/xcode_1_create_external_build_project.png
  83. 0 0
      contributing/development/configuring_an_ide/img/xcode_2_configure_scons.png
  84. 0 0
      contributing/development/configuring_an_ide/img/xcode_3_add_new_target.png
  85. 0 0
      contributing/development/configuring_an_ide/img/xcode_4_select_command_line_target.png
  86. 0 0
      contributing/development/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png
  87. 0 0
      contributing/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png
  88. 0 0
      contributing/development/configuring_an_ide/img/xcode_7_setup_build_post_action.png
  89. 0 0
      contributing/development/configuring_an_ide/img/xcode_8_setup_run_scheme.png
  90. 0 0
      contributing/development/configuring_an_ide/index.rst
  91. 0 0
      contributing/development/configuring_an_ide/kdevelop.rst
  92. 0 0
      contributing/development/configuring_an_ide/qt_creator.rst
  93. 0 0
      contributing/development/configuring_an_ide/visual_studio.rst
  94. 0 0
      contributing/development/configuring_an_ide/visual_studio_code.rst
  95. 0 0
      contributing/development/configuring_an_ide/xcode.rst
  96. 0 0
      contributing/development/core_and_modules/binding_to_external_libraries.rst
  97. 0 0
      contributing/development/core_and_modules/common_engine_methods_and_macros.rst
  98. 0 0
      contributing/development/core_and_modules/core_types.rst
  99. 0 0
      contributing/development/core_and_modules/custom_audiostreams.rst
  100. 0 0
      contributing/development/core_and_modules/custom_godot_servers.rst

+ 63 - 0
_tools/redirects/redirects.csv

@@ -1,6 +1,22 @@
 source,destination
 source,destination
 /about/index.html,/index.html
 /about/index.html,/index.html
 /classes/_classes.html,/classes/
 /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/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/gdnative-c-example.html,/tutorials/plugins/gdnative/gdnative-c-example.html
 /community/tutorials/gdnative/index.html,/tutorials/plugins/gdnative/index.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/bug_triage_guidelines.html,/community/contributing/bug_triage_guidelines.html
 /contributing/doc_and_l10n_guidelines.html,/community/contributing/doc_and_l10n_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
 /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/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/import_plugins.html,/tutorials/plugins/editor/import_plugins.html
 /development/plugins/index.html,/tutorials/plugins/editor/index.html
 /development/plugins/index.html,/tutorials/plugins/editor/index.html
 /development/plugins/making_plugins.html,/tutorials/plugins/editor/making_plugins.html
 /development/plugins/making_plugins.html,/tutorials/plugins/editor/making_plugins.html

+ 8 - 7
about/introduction.rst

@@ -89,19 +89,20 @@ relatively intuitive:
   new users.
   new users.
 - The :ref:`sec-tutorials` section can be read as needed,
 - The :ref:`sec-tutorials` section can be read as needed,
   in any order. It contains feature-specific tutorials and documentation.
   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,
   to the engine development, with the information on compiling the engine,
   contributing to the editor, or developing C++ modules.
   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,
 - 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
   which is also available directly within the engine's script editor. It is
   generated automatically from a file in the main source repository, therefore
   generated automatically from a file in the main source repository, therefore
   the generated files of the documentation are not meant to be modified. See
   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
 In addition to this documentation, you may also want to take a look at the
 various `Godot demo projects <https://github.com/godotengine/godot-demo-projects>`_.
 various `Godot demo projects <https://github.com/godotengine/godot-demo-projects>`_.

+ 0 - 108
community/contributing/index.rst

@@ -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
-  <https://github.com/godotengine/godot-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 <https://github.com/godotengine/godot>`_. 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

+ 0 - 76
community/contributing/updating_the_class_reference.rst

@@ -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 <doc_class_reference>`
-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 <https://github.com/godotengine/godot-docs/>`_
-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 <doc_class_reference_writing_guidelines>`.
-
-    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
-    <https://www.youtube.com/watch?v=5jeHXxeX-JY>`_.
-
-.. seealso::
-
-    Not sure which class to contribute to? Take a look at the class reference's
-    completion status `here <https://godotengine.github.io/doc-status/>`_.
-
-You can find the source files for the class reference in Godot's GitHub
-repository: `doc/classes/
-<https://github.com/godotengine/godot/tree/master/doc/classes>`_.
-
-.. note:: For some modules in the engine's source code, you'll find the XML
-          files in the ``modules/<module_name>/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
-             <doc_class_reference>`, hosted in the `godot-docs
-             <https://github.com/godotengine/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``.

+ 0 - 0
community/contributing/best_practices_for_engine_contributors.rst → contributing/development/best_practices_for_engine_contributors.rst


+ 0 - 0
community/contributing/code_style_guidelines.rst → contributing/development/code_style_guidelines.rst


+ 0 - 0
development/compiling/compiling_for_android.rst → contributing/development/compiling/compiling_for_android.rst


+ 0 - 0
development/compiling/compiling_for_ios.rst → contributing/development/compiling/compiling_for_ios.rst


+ 0 - 0
development/compiling/compiling_for_linuxbsd.rst → contributing/development/compiling/compiling_for_linuxbsd.rst


+ 0 - 0
development/compiling/compiling_for_macos.rst → contributing/development/compiling/compiling_for_macos.rst


+ 0 - 0
development/compiling/compiling_for_uwp.rst → contributing/development/compiling/compiling_for_uwp.rst


+ 0 - 0
development/compiling/compiling_for_web.rst → contributing/development/compiling/compiling_for_web.rst


+ 0 - 0
development/compiling/compiling_for_windows.rst → contributing/development/compiling/compiling_for_windows.rst


+ 0 - 0
development/compiling/compiling_with_mono.rst → contributing/development/compiling/compiling_with_mono.rst


+ 0 - 0
development/compiling/compiling_with_script_encryption_key.rst → contributing/development/compiling/compiling_with_script_encryption_key.rst


+ 0 - 0
development/compiling/cross-compiling_for_ios_on_linux.rst → contributing/development/compiling/cross-compiling_for_ios_on_linux.rst


+ 0 - 0
development/compiling/getting_source.rst → contributing/development/compiling/getting_source.rst


+ 0 - 0
development/compiling/img/andtemplates.png → contributing/development/compiling/img/andtemplates.png


+ 0 - 0
development/compiling/img/encryption_key.png → contributing/development/compiling/img/encryption_key.png


+ 0 - 0
development/compiling/img/lintemplates.png → contributing/development/compiling/img/lintemplates.png


+ 0 - 0
development/compiling/img/wintemplates.png → contributing/development/compiling/img/wintemplates.png


+ 2 - 2
development/compiling/index.rst → contributing/development/compiling/index.rst

@@ -1,5 +1,5 @@
-Compiling
-=========
+Building from source
+====================
 
 
 .. toctree::
 .. toctree::
    :maxdepth: 1
    :maxdepth: 1

+ 0 - 0
development/compiling/introduction_to_the_buildsystem.rst → contributing/development/compiling/introduction_to_the_buildsystem.rst


+ 0 - 0
development/compiling/optimizing_for_size.rst → contributing/development/compiling/optimizing_for_size.rst


+ 0 - 0
development/cpp/configuring_an_ide/android_studio.rst → contributing/development/configuring_an_ide/android_studio.rst


+ 0 - 0
development/cpp/configuring_an_ide/clion.rst → contributing/development/configuring_an_ide/clion.rst


+ 0 - 0
development/cpp/configuring_an_ide/code_blocks.rst → contributing/development/configuring_an_ide/code_blocks.rst


+ 0 - 0
development/cpp/configuring_an_ide/img/android_studio_setup_project_1.png → contributing/development/configuring_an_ide/img/android_studio_setup_project_1.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-add-configuration.png → contributing/development/configuring_an_ide/img/clion-add-configuration.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-add-custom-build-application.png → contributing/development/configuring_an_ide/img/clion-add-custom-build-application.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-build-run.png → contributing/development/configuring_an_ide/img/clion-build-run.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-create-build-tool.png → contributing/development/configuring_an_ide/img/clion-create-build-tool.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-create-clean-tool.png → contributing/development/configuring_an_ide/img/clion-create-clean-tool.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-external-tools.png → contributing/development/configuring_an_ide/img/clion-external-tools.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-preferences.png → contributing/development/configuring_an_ide/img/clion-preferences.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-run-configuration.png → contributing/development/configuring_an_ide/img/clion-run-configuration.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-select-tools.png → contributing/development/configuring_an_ide/img/clion-select-tools.png


+ 0 - 0
development/cpp/configuring_an_ide/img/clion-target.png → contributing/development/configuring_an_ide/img/clion-target.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_block_use_tab_character.png → contributing/development/configuring_an_ide/img/code_block_use_tab_character.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_add_files_recursively.png → contributing/development/configuring_an_ide/img/code_blocks_add_files_recursively.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_build_targets.png → contributing/development/configuring_an_ide/img/code_blocks_build_targets.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_compiler_and_configuration.png → contributing/development/configuring_an_ide/img/code_blocks_compiler_and_configuration.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_file_new_project.png → contributing/development/configuring_an_ide/img/code_blocks_file_new_project.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_new_empty_project.png → contributing/development/configuring_an_ide/img/code_blocks_new_empty_project.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_open_build_options.png → contributing/development/configuring_an_ide/img/code_blocks_open_build_options.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_open_properties.png → contributing/development/configuring_an_ide/img/code_blocks_open_properties.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_project_properties.png → contributing/development/configuring_an_ide/img/code_blocks_project_properties.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_project_title_and_location.png → contributing/development/configuring_an_ide/img/code_blocks_project_title_and_location.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_scons_clean.png → contributing/development/configuring_an_ide/img/code_blocks_scons_clean.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_scons_minimum.png → contributing/development/configuring_an_ide/img/code_blocks_scons_minimum.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_scons_windows.png → contributing/development/configuring_an_ide/img/code_blocks_scons_windows.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_select_files.png → contributing/development/configuring_an_ide/img/code_blocks_select_files.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_update_editor_settings.png → contributing/development/configuring_an_ide/img/code_blocks_update_editor_settings.png


+ 0 - 0
development/cpp/configuring_an_ide/img/code_blocks_wizard_welcome.png → contributing/development/configuring_an_ide/img/code_blocks_wizard_welcome.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_addincludes.png → contributing/development/configuring_an_ide/img/kdevelop_addincludes.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_buildconfig.png → contributing/development/configuring_an_ide/img/kdevelop_buildconfig.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_configlaunches.png → contributing/development/configuring_an_ide/img/kdevelop_configlaunches.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_configlaunches2.png → contributing/development/configuring_an_ide/img/kdevelop_configlaunches2.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_custombuild.png → contributing/development/configuring_an_ide/img/kdevelop_custombuild.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_newproject.png → contributing/development/configuring_an_ide/img/kdevelop_newproject.png


+ 0 - 0
development/cpp/configuring_an_ide/img/kdevelop_openconfig.png → contributing/development/configuring_an_ide/img/kdevelop_openconfig.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-apply-import-filter.png → contributing/development/configuring_an_ide/img/qtcreator-apply-import-filter.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-edit-codestyle.png → contributing/development/configuring_an_ide/img/qtcreator-edit-codestyle.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-edit-files-menu.png → contributing/development/configuring_an_ide/img/qtcreator-edit-files-menu.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-new-project.png → contributing/development/configuring_an_ide/img/qtcreator-new-project.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-options-cpp.png → contributing/development/configuring_an_ide/img/qtcreator-options-cpp.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-project-name-includes.png → contributing/development/configuring_an_ide/img/qtcreator-project-name-includes.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-projects-build.png → contributing/development/configuring_an_ide/img/qtcreator-projects-build.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-run-command.png → contributing/development/configuring_an_ide/img/qtcreator-run-command.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-set-project-path.png → contributing/development/configuring_an_ide/img/qtcreator-set-project-path.png


+ 0 - 0
development/cpp/configuring_an_ide/img/qtcreator-set-scons-command.png → contributing/development/configuring_an_ide/img/qtcreator-set-scons-command.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vs_1_install_cpp_package.png → contributing/development/configuring_an_ide/img/vs_1_install_cpp_package.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vs_2_project_properties.png → contributing/development/configuring_an_ide/img/vs_2_project_properties.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vs_3_debug_command_line.png → contributing/development/configuring_an_ide/img/vs_3_debug_command_line.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vs_4_debugging_main.png → contributing/development/configuring_an_ide/img/vs_4_debugging_main.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vscode_1_create_launch.json.png → contributing/development/configuring_an_ide/img/vscode_1_create_launch.json.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vscode_2_launch.json.png → contributing/development/configuring_an_ide/img/vscode_2_launch.json.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vscode_3_tasks.json.png → contributing/development/configuring_an_ide/img/vscode_3_tasks.json.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vscode_configure_task.png → contributing/development/configuring_an_ide/img/vscode_configure_task.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vscode_create_tasksjson.png → contributing/development/configuring_an_ide/img/vscode_create_tasksjson.png


+ 0 - 0
development/cpp/configuring_an_ide/img/vscode_create_tasksjson_others.png → contributing/development/configuring_an_ide/img/vscode_create_tasksjson_others.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_1_create_external_build_project.png → contributing/development/configuring_an_ide/img/xcode_1_create_external_build_project.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_2_configure_scons.png → contributing/development/configuring_an_ide/img/xcode_2_configure_scons.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_3_add_new_target.png → contributing/development/configuring_an_ide/img/xcode_3_add_new_target.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_4_select_command_line_target.png → contributing/development/configuring_an_ide/img/xcode_4_select_command_line_target.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png → contributing/development/configuring_an_ide/img/xcode_5_after_add_godot_source_to_project.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png → contributing/development/configuring_an_ide/img/xcode_6_after_add_godot_source_to_project_2.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_7_setup_build_post_action.png → contributing/development/configuring_an_ide/img/xcode_7_setup_build_post_action.png


+ 0 - 0
development/cpp/configuring_an_ide/img/xcode_8_setup_run_scheme.png → contributing/development/configuring_an_ide/img/xcode_8_setup_run_scheme.png


+ 0 - 0
development/cpp/configuring_an_ide/index.rst → contributing/development/configuring_an_ide/index.rst


+ 0 - 0
development/cpp/configuring_an_ide/kdevelop.rst → contributing/development/configuring_an_ide/kdevelop.rst


+ 0 - 0
development/cpp/configuring_an_ide/qt_creator.rst → contributing/development/configuring_an_ide/qt_creator.rst


+ 0 - 0
development/cpp/configuring_an_ide/visual_studio.rst → contributing/development/configuring_an_ide/visual_studio.rst


+ 0 - 0
development/cpp/configuring_an_ide/visual_studio_code.rst → contributing/development/configuring_an_ide/visual_studio_code.rst


+ 0 - 0
development/cpp/configuring_an_ide/xcode.rst → contributing/development/configuring_an_ide/xcode.rst


+ 0 - 0
development/cpp/binding_to_external_libraries.rst → contributing/development/core_and_modules/binding_to_external_libraries.rst


+ 0 - 0
development/cpp/common_engine_methods_and_macros.rst → contributing/development/core_and_modules/common_engine_methods_and_macros.rst


+ 0 - 0
development/cpp/core_types.rst → contributing/development/core_and_modules/core_types.rst


+ 0 - 0
development/cpp/custom_audiostreams.rst → contributing/development/core_and_modules/custom_audiostreams.rst


+ 0 - 0
development/cpp/custom_godot_servers.rst → contributing/development/core_and_modules/custom_godot_servers.rst


Some files were not shown because too many files changed in this diff