diff --git a/_static/img/tutorials/3d.webp b/_static/img/tutorials/3d.webp new file mode 100644 index 00000000000..e855bd62a13 Binary files /dev/null and b/_static/img/tutorials/3d.webp differ diff --git a/contributing/index.rst b/contributing/index.rst new file mode 100644 index 00000000000..d086e09bdb2 --- /dev/null +++ b/contributing/index.rst @@ -0,0 +1,33 @@ +.. _doc_contributing: + +Contributing +============ + +Thanks for your interest in contributing in Godot! + +Not sure how you could help the Godot project? See :ref:`doc_ways_to_contribute` +which lists several methods in which you can help improve Godot. You don't need +programming experience to contribute to Godot, as there are several ways to +improve the engine that do not involve programming. + +These pages contain information about contributing to the engine's codebase and +documentation: + +Contribute to the engine code +----------------------------- + +.. toctree:: + :maxdepth: 1 + :name: toc-devel-contributing-code + + workflow/index + development/index + +Contribute to the documentation +------------------------------- + +.. toctree:: + :maxdepth: 1 + :name: toc-devel-contributing-docs + + documentation/index diff --git a/index.rst b/index.rst index 1615a93af51..f121a0bd45c 100644 --- a/index.rst +++ b/index.rst @@ -31,8 +31,71 @@ to this documentation, we recommend that you read the :ref:`introduction page ` to get an overview of what this documentation has to offer. -The table of contents in the sidebar should let you easily access the documentation -for your topic of interest. You can also use the search function in the top-left corner. +To begin reading the relevant documentation, select the tile that matches your profile: + +.. raw:: html + + +
+ + I've never made a game before,
+ I want to make a game. +
+ + I know how to make a game,
+ I want to know how to use Godot. +
+ + I know how to use Godot,
+ I want to learn more advanced Godot topics. +
+ + I know how to use Godot,
+ I want to contribute to Godot. +
+
+
+ +You can also use the table of contents in the sidebar to access easily access +any section of the documentation for your topic of interest. You can also use +the search function in the top-left corner. Get involved ------------ diff --git a/tutorials/index.rst b/tutorials/index.rst new file mode 100644 index 00000000000..7fd711bbdc7 --- /dev/null +++ b/tutorials/index.rst @@ -0,0 +1,138 @@ +.. _doc_tutorials: + +Tutorials +========= + +.. Sections below are split into two groups. First come meta sections, covering + general matters. Below that different areas of the engine are listed. + These sections are sorted alphabetically. Please keep them that way. + +General +------- + +.. toctree:: + :maxdepth: 1 + :name: toc-learn-tutorials-general + + best_practices/index + editor/index + migrating/index + +Topics +------ + +.. raw:: html + + + + + 2D
+ Learn the 2D editor, rendering and level design functionality. +
+ + 3D
+ Learn the 3D editor, rendering and level design functionality. +
+ + Animation
+ Learn to set up animations, play and create videos. +
+ + Assets pipeline
+ Learn to import and export 2D, 3D, audio resources. +
+ + Audio
+ Learn to set up audio playback for sound effects and music in your project. +
+ + Export
+ Learn to package and export your project for distribution on different platforms. +
+ + Input/output (I/O)
+ Learn to read and write files, such as save games and configuration files. +
+ + Internationalization (i18n)
+ Learn to set up your project to support multiple languages. +
+ + Inputs
+ Learn setting up keyboard, mouse, controller and touch inputs for your project. +
+ + Mathematics
+ Learn vector math and matrices to better understand game development. +
+ + Navigation
+ Learn to make AI characters navigate seamlessly in a game world. +
+ + Networking
+ Learn to communicate with a server using the high-level multiplayer API or low-level network APIs. +
+ + Performance
+ Learn to diagnose performance issues and find optimizations in your project. +
+ + Physics
+ Learn to set up rigid, character, soft and vehicle physics simulations in your project. +
+ + Platform-specific
+ Learn platform-specific adjustments to make your project work across multiple platforms. +
+ + Plugins
+ Learn to use and create editor plugins to extend functionality. +
+ + Rendering
+ Learn to set up and optimize rendering features for your project. +
+ + Scripting
+ Learn to program games using GDScript and C#. +
+ + Shaders
+ Learn to create custom visual effects using text-based and visual shaders. +
+ + User Interface (UI)
+ Learn to set up user interfaces. +
+ + Mixed Reality (XR)
+ Learn to set up Virtual Reality and Augmented Reality. +