Merge pull request #6826 from YuriSizov/web-improve-naming-navigation

Improve naming and organization of some manual articles
godotengine · Feb 26, 2023 · 6fae64f · 6fae64f
2 parents af25625 + d524544
commit 6fae64f
Show file tree

Hide file tree

Showing 64 changed files with 99 additions and 40 deletions.
diff --git a/_tools/redirects/redirects.csv b/_tools/redirects/redirects.csv
@@ -324,7 +324,13 @@ source,destination
 /reference/shading_language.html,/learning/features/shading/shading_language.html
 /reference/unity_to_godot.html,/learning/editor/unity_to_godot.html
 /reference/variant_class.html,/development/cpp/variant_class.html
+/tutorials/3d/introduction_to_global_illumination.html,/tutorials/3d/global_illumination/introduction_to_global_illumination.html
+/tutorials/3d/faking_global_illumination.html,/tutorials/3d/global_illumination/faking_global_illumination.html
 /tutorials/3d/inverse_kinematics.html,/community/tutorials/3d/inverse_kinematics.html
+/tutorials/3d/reflection_probes.html,/tutorials/3d/global_illumination/reflection_probes.html
+/tutorials/3d/sdfgi.html,/tutorials/3d/global_illumination/using_sdfgi.html
+/tutorials/3d/using_lightmap_gi.html,/tutorials/3d/global_illumination/using_lightmap_gi.html
+/tutorials/3d/using_voxel_gi.html,/tutorials/3d/global_illumination/using_voxel_gi.html
 /tutorials/3d/vertex_animation/animating_thousands_of_fish.html,/tutorials/performance/vertex_animation/animating_thousands_of_fish.html
 /tutorials/3d/vertex_animation/controlling_thousands_of_fish.html,/tutorials/performance/vertex_animation/controlling_thousands_of_fish.html
 /tutorials/3d/vertex_animation/index.html,/tutorials/performance/vertex_animation/index.html
@@ -375,6 +381,9 @@ source,destination
 /tutorials/optimization/using_multimesh.html,/tutorials/performance/using_multimesh.html
 /tutorials/optimization/using_servers.html,/tutorials/performance/using_servers.html
 /tutorials/platform/android_in_app_purchases.html,/tutorials/platform/android/android_in_app_purchases.html
+/tutorials/platform/customizing_html5_shell.html,/tutorials/platform/web/customizing_html5_shell.html
+/tutorials/platform/html5_shell_classref.html,/tutorials/platform/web/html5_shell_classref.html
+/tutorials/platform/platform_html5.html,/tutorials/platform/web/index.html
 /tutorials/plugins/android/android_plugin.html,/tutorials/platform/android/android_plugin.html
 /tutorials/plugins/android/index.html,/tutorials/platform/android/index.html
 /tutorials/plugins/gdnative/gdnative-c-example.html,/tutorials/scripting/gdnative/gdnative_c_example.html

diff --git a/index.rst b/index.rst
@@ -114,9 +114,9 @@ the top-level ``index.html`` in a web browser.
    tutorials/assets_pipeline/index
    tutorials/audio/index
    tutorials/export/index
+   tutorials/io/index
    tutorials/i18n/index
    tutorials/inputs/index
-   tutorials/io/index
    tutorials/math/index
    tutorials/navigation/index
    tutorials/networking/index

diff --git a/tutorials/2d/index.rst b/tutorials/2d/index.rst
@@ -7,11 +7,35 @@
 
    canvas_layers
    2d_transforms
-   using_tilemaps
-   particle_systems_2d
-   2d_movement
+
+Rendering
+---------
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-2d-rendering
+
    2d_lights_and_shadows
    2d_meshes
-   custom_drawing_in_2d
    2d_sprite_animation
+   particle_systems_2d
    2d_antialiasing
+   custom_drawing_in_2d
+
+Physics and movement
+--------------------
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-2d-physics
+
+   2d_movement
+
+Tools
+-----
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-2d-tools
+
+   using_tilemaps
diff --git a/tutorials/2d/particle_systems_2d.rst b/tutorials/2d/particle_systems_2d.rst
@@ -2,8 +2,8 @@
 
 .. _doc_particle_systems_2d:
 
-Particle systems (2D)
-=====================
+2D particle systems
+===================
 
 Intro
 -----

diff --git a/tutorials/3d/environment_and_post_processing.rst b/tutorials/3d/environment_and_post_processing.rst
@@ -243,7 +243,7 @@ In general, you should only rely on ambient light alone for simple scenes or
 large exteriors. You may also do so to boost performance. Ambient light is fast
 to render, but it doesn't provide the best lighting quality. It's better to
 generate ambient light from :ref:`ReflectionProbe <doc_reflection_probes>`,
-:ref:`VoxelGI <doc_using_voxel_gi>` or :ref:`SDFGI <doc_sdfgi>`, as these
+:ref:`VoxelGI <doc_using_voxel_gi>` or :ref:`SDFGI <doc_using_sdfgi>`, as these
 will simulate how indirect light propagates more accurately. Below is a comparison,
 in terms of quality, between using a flat ambient color and a VoxelGI:
 
@@ -528,7 +528,7 @@ illumination for off-screen elements (unlike :abbr:`Screen-Space Indirect Lighti
 
 .. seealso::
 
-    See :ref:`doc_sdfgi` for instructions on setting up this global
+    See :ref:`doc_using_sdfgi` for instructions on setting up this global
     illumination technique.
 
 .. image:: img/environment_sdfgi.webp

diff --git a/tutorials/3d/faking_global_illumination.rst → ...lumination/faking_global_illumination.rst b/tutorials/3d/faking_global_illumination.rst → ...lumination/faking_global_illumination.rst
diff --git a/...aking_global_illumination_comparison.webp → ...aking_global_illumination_comparison.webp b/...aking_global_illumination_comparison.webp → ...aking_global_illumination_comparison.webp
diff --git a/...g/gi_lightmap_gi_direct_and_indirect.webp → ...g/gi_lightmap_gi_direct_and_indirect.webp b/...g/gi_lightmap_gi_direct_and_indirect.webp → ...g/gi_lightmap_gi_direct_and_indirect.webp
diff --git a/.../3d/img/gi_lightmap_gi_indirect_only.webp → ...ion/img/gi_lightmap_gi_indirect_only.webp b/.../3d/img/gi_lightmap_gi_indirect_only.webp → ...ion/img/gi_lightmap_gi_indirect_only.webp
diff --git a/...ap_gi_indirect_only_reflection_probe.webp → ...ap_gi_indirect_only_reflection_probe.webp b/...ap_gi_indirect_only_reflection_probe.webp → ...ap_gi_indirect_only_reflection_probe.webp
diff --git a/tutorials/3d/img/gi_none.webp → ...s/3d/global_illumination/img/gi_none.webp b/tutorials/3d/img/gi_none.webp → ...s/3d/global_illumination/img/gi_none.webp
diff --git a/...ials/3d/img/gi_none_reflection_probe.webp → ...ination/img/gi_none_reflection_probe.webp b/...ials/3d/img/gi_none_reflection_probe.webp → ...ination/img/gi_none_reflection_probe.webp
diff --git a/tutorials/3d/img/gi_sdfgi.webp → .../3d/global_illumination/img/gi_sdfgi.webp b/tutorials/3d/img/gi_sdfgi.webp → .../3d/global_illumination/img/gi_sdfgi.webp
diff --git a/tutorials/3d/img/gi_ssil_only.webp → ...global_illumination/img/gi_ssil_only.webp b/tutorials/3d/img/gi_ssil_only.webp → ...global_illumination/img/gi_ssil_only.webp
diff --git a/tutorials/3d/img/gi_voxel_gi.webp → .../global_illumination/img/gi_voxel_gi.webp b/tutorials/3d/img/gi_voxel_gi.webp → .../global_illumination/img/gi_voxel_gi.webp
diff --git a/...s/3d/img/global_illumination_example.webp → ...tion/img/global_illumination_example.webp b/...s/3d/img/global_illumination_example.webp → ...tion/img/global_illumination_example.webp
diff --git a/tutorials/3d/img/lightmap_gi_bake.png → ...bal_illumination/img/lightmap_gi_bake.png b/tutorials/3d/img/lightmap_gi_bake.png → ...bal_illumination/img/lightmap_gi_bake.png
diff --git a/tutorials/3d/img/lightmap_gi_bake_mode.png → ...llumination/img/lightmap_gi_bake_mode.png b/tutorials/3d/img/lightmap_gi_bake_mode.png → ...llumination/img/lightmap_gi_bake_mode.png
diff --git a/tutorials/3d/img/lightmap_gi_blender.png → ..._illumination/img/lightmap_gi_blender.png b/tutorials/3d/img/lightmap_gi_blender.png → ..._illumination/img/lightmap_gi_blender.png
diff --git a/tutorials/3d/img/lightmap_gi_bounds.png → ...l_illumination/img/lightmap_gi_bounds.png b/tutorials/3d/img/lightmap_gi_bounds.png → ...l_illumination/img/lightmap_gi_bounds.png
diff --git a/tutorials/3d/img/lightmap_gi_capture.png → ..._illumination/img/lightmap_gi_capture.png b/tutorials/3d/img/lightmap_gi_capture.png → ..._illumination/img/lightmap_gi_capture.png
diff --git a/tutorials/3d/img/lightmap_gi_comparison.png → ...lumination/img/lightmap_gi_comparison.png b/tutorials/3d/img/lightmap_gi_comparison.png → ...lumination/img/lightmap_gi_comparison.png
diff --git a/tutorials/3d/img/lightmap_gi_import.webp → ..._illumination/img/lightmap_gi_import.webp b/tutorials/3d/img/lightmap_gi_import.webp → ..._illumination/img/lightmap_gi_import.webp
diff --git a/tutorials/3d/img/lightmap_gi_lmsize.png → ...l_illumination/img/lightmap_gi_lmsize.png b/tutorials/3d/img/lightmap_gi_lmsize.png → ...l_illumination/img/lightmap_gi_lmsize.png
diff --git a/...d/img/lightmap_gi_mesh_import_meshes.webp → ...n/img/lightmap_gi_mesh_import_meshes.webp b/...d/img/lightmap_gi_mesh_import_meshes.webp → ...n/img/lightmap_gi_mesh_import_meshes.webp
diff --git a/tutorials/3d/img/lightmap_gi_mesh_menu.png → ...llumination/img/lightmap_gi_mesh_menu.png b/tutorials/3d/img/lightmap_gi_mesh_menu.png → ...llumination/img/lightmap_gi_mesh_menu.png
diff --git a/...als/3d/img/lightmap_gi_omnilight_size.png → ...nation/img/lightmap_gi_omnilight_size.png b/...als/3d/img/lightmap_gi_omnilight_size.png → ...nation/img/lightmap_gi_omnilight_size.png
diff --git a/tutorials/3d/img/lightmap_gi_scene.png → ...al_illumination/img/lightmap_gi_scene.png b/tutorials/3d/img/lightmap_gi_scene.png → ...al_illumination/img/lightmap_gi_scene.png
diff --git a/tutorials/3d/img/lightmap_gi_use.png → ...obal_illumination/img/lightmap_gi_use.png b/tutorials/3d/img/lightmap_gi_use.png → ...obal_illumination/img/lightmap_gi_use.png
diff --git a/tutorials/3d/img/lightmap_gi_uvchannel.png → ...llumination/img/lightmap_gi_uvchannel.png b/tutorials/3d/img/lightmap_gi_uvchannel.png → ...llumination/img/lightmap_gi_uvchannel.png
diff --git a/...g/reflection_probes_reflection_probe.webp → ...g/reflection_probes_reflection_probe.webp b/...g/reflection_probes_reflection_probe.webp → ...g/reflection_probes_reflection_probe.webp
diff --git a/...flection_probes_reflection_probe_ssr.webp → ...flection_probes_reflection_probe_ssr.webp b/...flection_probes_reflection_probe_ssr.webp → ...flection_probes_reflection_probe_ssr.webp
diff --git a/tutorials/3d/img/reflection_probes_ssr.webp → ...lumination/img/reflection_probes_ssr.webp b/tutorials/3d/img/reflection_probes_ssr.webp → ...lumination/img/reflection_probes_ssr.webp
diff --git a/tutorials/3d/img/average.webp → ...lobal_illumination/img/score_average.webp b/tutorials/3d/img/average.webp → ...lobal_illumination/img/score_average.webp
diff --git a/tutorials/3d/img/bad.webp → ...3d/global_illumination/img/score_bad.webp b/tutorials/3d/img/bad.webp → ...3d/global_illumination/img/score_bad.webp
diff --git a/tutorials/3d/img/good.webp → ...d/global_illumination/img/score_good.webp b/tutorials/3d/img/good.webp → ...d/global_illumination/img/score_good.webp
diff --git a/tutorials/3d/global_illumination/index.rst b/tutorials/3d/global_illumination/index.rst
@@ -0,0 +1,15 @@
+.. _doc_global_illumination:
+
+Global illumination
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-3d-global-illumination
+
+   introduction_to_global_illumination
+   using_voxel_gi
+   using_sdfgi
+   using_lightmap_gi
+   reflection_probes
+   faking_global_illumination
diff --git a/...d/introduction_to_global_illumination.rst → ...n/introduction_to_global_illumination.rst b/...d/introduction_to_global_illumination.rst → ...n/introduction_to_global_illumination.rst
@@ -317,18 +317,18 @@ User work needed
 
 - **ReflectionProbe:** Placed manually by the user.
 
-.. |good| image:: img/good.webp
+.. |good| image:: img/score_good.webp
 
-.. |average| image:: img/average.webp
+.. |average| image:: img/score_average.webp
 
-.. |bad| image:: img/bad.webp
+.. |bad| image:: img/score_bad.webp
 
 Summary
 ^^^^^^^
 
 If you are unsure about which GI technique to use:
 
-- For desktop games, it's a good idea to start with :ref:`SDFGI <doc_sdfgi>`
+- For desktop games, it's a good idea to start with :ref:`SDFGI <doc_using_sdfgi>`
   first as it requires the least amount of setup. Move to other GI techniques
   later if needed. To improve performance on low-end GPUs and integrated
   graphics, consider adding an option to disable SDFGI or :ref:`VoxelGI

diff --git a/tutorials/3d/reflection_probes.rst → ...global_illumination/reflection_probes.rst b/tutorials/3d/reflection_probes.rst → ...global_illumination/reflection_probes.rst
@@ -7,7 +7,7 @@ As stated in the :ref:`doc_standard_material_3d`, objects can show reflected and
 diffuse light. Reflection probes are used as a source of reflected *and* ambient
 light for objects inside their area of influence. They can be used to provide
 more accurate reflections than :ref:`VoxelGI <doc_using_voxel_gi>` and
-:ref:`SDFGI <doc_sdfgi>` while being fairly cheap on system resources.
+:ref:`SDFGI <doc_using_sdfgi>` while being fairly cheap on system resources.
 
 Since reflection probes can also store ambient light, they can be used as a
 low-end alternative to VoxelGI and SDFGI when :ref:`baked lightmaps

diff --git a/tutorials/3d/using_lightmap_gi.rst → ...global_illumination/using_lightmap_gi.rst b/tutorials/3d/using_lightmap_gi.rst → ...global_illumination/using_lightmap_gi.rst
@@ -5,7 +5,7 @@ Using Lightmap global illumination
 
 Baked lightmaps are a workflow for adding indirect (or fully baked)
 lighting to a scene. Unlike the :ref:`VoxelGI <doc_using_voxel_gi>` and
-:ref:`SDFGI <doc_sdfgi>` approaches, baked lightmaps work fine on low-end PCs
+:ref:`SDFGI <doc_using_sdfgi>` approaches, baked lightmaps work fine on low-end PCs
 and mobile devices, as they consume almost no resources at run-time. Also unlike
 VoxelGI and SDFGI, baked lightmaps can optionally be used to store direct
 lighting, which provides even further performance gains.

diff --git a/tutorials/3d/sdfgi.rst → ...ls/3d/global_illumination/using_sdfgi.rst b/tutorials/3d/sdfgi.rst → ...ls/3d/global_illumination/using_sdfgi.rst
@@ -1,4 +1,4 @@
-.. _doc_sdfgi:
+.. _doc_using_sdfgi:
 
 Signed distance field global illumination (SDFGI)
 =================================================

diff --git a/tutorials/3d/using_voxel_gi.rst → ...3d/global_illumination/using_voxel_gi.rst b/tutorials/3d/using_voxel_gi.rst → ...3d/global_illumination/using_voxel_gi.rst
diff --git a/tutorials/3d/img/giprobe_bake.png b/tutorials/3d/img/giprobe_bake.png
diff --git a/tutorials/3d/img/giprobe_bake_property.png b/tutorials/3d/img/giprobe_bake_property.png
diff --git a/tutorials/3d/img/giprobe_indirect.png b/tutorials/3d/img/giprobe_indirect.png
diff --git a/tutorials/3d/img/giprobe_indirect_energy_result.png b/tutorials/3d/img/giprobe_indirect_energy_result.png
diff --git a/tutorials/3d/img/giprobe_interior.png b/tutorials/3d/img/giprobe_interior.png
diff --git a/tutorials/3d/img/giprobe_interior_setting.png b/tutorials/3d/img/giprobe_interior_setting.png
diff --git a/tutorials/3d/img/giprobe_light_indirect.png b/tutorials/3d/img/giprobe_light_indirect.png
diff --git a/tutorials/3d/img/giprobe_quality.png b/tutorials/3d/img/giprobe_quality.png
diff --git a/tutorials/3d/img/giprobe_ref_blending.png b/tutorials/3d/img/giprobe_ref_blending.png
diff --git a/tutorials/3d/img/giprobe_tweaking.png b/tutorials/3d/img/giprobe_tweaking.png
diff --git a/tutorials/3d/img/giprobe_voxel_reflections.png b/tutorials/3d/img/giprobe_voxel_reflections.png
diff --git a/tutorials/3d/img/giprobe_wrap.png b/tutorials/3d/img/giprobe_wrap.png
diff --git a/tutorials/3d/index.rst b/tutorials/3d/index.rst
@@ -7,35 +7,46 @@
 
    introduction_to_3d
    using_transforms
+   procedural_geometry/index
+   3d_text
+
+Rendering
+---------
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-3d-rendering
+
    3d_rendering_limitations
    standard_material_3d
    lights_and_shadows
    physical_light_and_camera_units
+   high_dynamic_range
+   global_illumination/index
    environment_and_post_processing
-   3d_antialiasing
-   resolution_scaling
    volumetric_fog
-   high_dynamic_range
-   using_gridmaps
+   3d_antialiasing
+
+Optimization
+------------
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-learn-features-3d-optimization
+
    using_multi_mesh_instance
-   csg_tools
-   procedural_geometry/index
-   3d_text
    mesh_lod
    visibility_ranges
    occlusion_culling
+   resolution_scaling
    variable_rate_shading
 
-Global illumination
--------------------
+Tools
+-----
 
 .. toctree::
    :maxdepth: 1
-   :name: toc-learn-features-3d-global-illumination
-
-   introduction_to_global_illumination
-   using_voxel_gi
-   sdfgi
-   using_lightmap_gi
-   reflection_probes
-   faking_global_illumination
+   :name: toc-learn-features-3d-tools
+
+   csg_tools
+   using_gridmaps
diff --git a/tutorials/3d/standard_material_3d.rst b/tutorials/3d/standard_material_3d.rst
@@ -268,7 +268,7 @@ Emission
 
 *Emission* specifies how much light is emitted by the material (keep in mind this
 does not include light surrounding geometry unless :ref:`VoxelGI <doc_using_voxel_gi>`
-or :ref:`SDFGI <doc_sdfgi>` are used). This value is added to the resulting
+or :ref:`SDFGI <doc_using_sdfgi>` are used). This value is added to the resulting
 final image and is not affected by other lighting in the scene.
 
 .. image:: img/spatial_material15.png

diff --git a/tutorials/inputs/index.rst b/tutorials/inputs/index.rst
@@ -1,5 +1,5 @@
-Inputs
-======
+Input handling
+==============
 
 .. toctree::
    :maxdepth: 1

diff --git a/tutorials/io/index.rst b/tutorials/io/index.rst
@@ -1,5 +1,5 @@
-Input and Output (I/O)
-======================
+File and data I/O
+=================
 
 .. toctree::
     :maxdepth: 1

diff --git a/tutorials/platform/index.rst b/tutorials/platform/index.rst
@@ -9,5 +9,5 @@ Platform-specific
 
    android/index
    ios/index
-   platform_html5
+   web/index
    consoles
diff --git a/...ials/platform/customizing_html5_shell.rst → .../platform/web/customizing_html5_shell.rst b/...ials/platform/customizing_html5_shell.rst → .../platform/web/customizing_html5_shell.rst
diff --git a/tutorials/platform/html5_shell_classref.rst → ...als/platform/web/html5_shell_classref.rst b/tutorials/platform/html5_shell_classref.rst → ...als/platform/web/html5_shell_classref.rst
diff --git a/...als/platform/img/html5_export_options.png → ...platform/web/img/html5_export_options.png b/...als/platform/img/html5_export_options.png → ...platform/web/img/html5_export_options.png
diff --git a/tutorials/platform/platform_html5.rst → tutorials/platform/web/index.rst b/tutorials/platform/platform_html5.rst → tutorials/platform/web/index.rst
diff --git a/tutorials/ui/index.rst b/tutorials/ui/index.rst
@@ -1,6 +1,6 @@
 .. _doc_user_interface:
 
-User Interface (UI)
+User interface (UI)
 ===================
 
 In this section of the tutorial we explain the basics of creating a graphical