Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
125 commits
Select commit Hold shift + click to select a range
dd8e682
Update tutorials.rst - added free Zenva resources
fariazz Apr 11, 2024
2017152
Add docs contribution checklist page
tetrapod00 Oct 30, 2024
e621b00
Update games made with Godot in Getting Started
tetrapod00 Feb 9, 2025
ba65fc7
Add Odin binding to community binding list
dresswithpockets Feb 28, 2025
53872be
Update importing_audio_samples.rst
GlitchedCode922 Mar 2, 2025
c4a311d
Update importing_audio_samples.rst
GlitchedCode922 Mar 2, 2025
f48ae90
Update importing_audio_samples.rst
GlitchedCode922 Mar 2, 2025
2b502e4
Fix Grammar
GlitchedCode922 Mar 2, 2025
974dd5a
Document Glow Upscale Mode project setting in Environment and post-pr…
Calinou Mar 3, 2025
0fd17fe
Fix documented function call inopenxr reference space docs
DanielKinsman Mar 3, 2025
c281b2a
Remove mention of Handbrake from playing_videos.rst (#10732)
JormaRysky Mar 3, 2025
df28473
Merge pull request #10735 from Calinou/environment-post-processing-gl…
skyace65 Mar 3, 2025
eb24e78
Merge pull request #10736 from DanielKinsman/patch-1
skyace65 Mar 3, 2025
da17e45
Merge pull request #10170 from tetrapod00/contribution-checklist
skyace65 Mar 4, 2025
820fdbe
String.format() wrong placeholder syntax
RazerTexz Mar 4, 2025
7bf735d
Update c_sharp_basics.rst (MonoDevelop has been abandoned)
reisnersteve Mar 4, 2025
1ce1ede
Merge pull request #10742 from reisnersteve/patch-1
tetrapod00 Mar 4, 2025
38167ab
Document `editor_hint` and `editor_runtime` feature flags
DeeJayLSP Mar 4, 2025
53d814e
Add reminder to free RID's in compute shader tutorial
DevPoodle Mar 4, 2025
5cdcca8
Fix inaccurate `read_string_from_stdin` migration info.
bruvzg Mar 5, 2025
bfa102b
Merge pull request #10745 from DeeJayLSP/hint_runtime
skyace65 Mar 5, 2025
ce2a1b5
Merge pull request #10741 from RazerTexz/patch-1
skyace65 Mar 5, 2025
cfd108e
Merge pull request #10748 from bruvzg/buf_bind
skyace65 Mar 6, 2025
8761d72
Update tutorials/assets_pipeline/importing_audio_samples.rst
GlitchedCode922 Mar 6, 2025
8fe5fea
Fix itch.io link in Exporting for the Web (#10751)
NormPlum Mar 6, 2025
90f1ee0
Update tutorials/assets_pipeline/importing_audio_samples.rst
skyace65 Mar 6, 2025
996095e
Merge pull request #10729 from GlitchedCode922/master
skyace65 Mar 6, 2025
0b174c6
Play the mob animation after setting it in Your first 2D game (#10752)
utsav132 Mar 7, 2025
7419a4e
Link to C# external editor documentation in Visual Studio and VS Code…
Calinou Mar 12, 2025
146182c
Clarify the behavior of MeshInstance3D automatic instancing
Calinou Mar 13, 2025
2c08d1a
Update 2D batching notice in Internal rendering architecture for Godo…
Calinou Mar 13, 2025
ff9c75d
Merge pull request #10761 from Calinou/configuring-an-ide-csharp
skyace65 Mar 14, 2025
04f85c2
Update Bug triage guidelines
tetrapod00 Feb 13, 2025
007caa9
Merge pull request #10683 from tetrapod00/bug-triage-update
skyace65 Mar 16, 2025
df7dd18
Replace axes colors in image
BLooperZ Mar 16, 2025
ff50eb0
Update making_main_screen_plugins.rst
lordstickman543 Mar 16, 2025
1333570
Merge pull request #10771 from lordstickman543/patch-1
skyace65 Mar 16, 2025
58a5b50
Create xr full screen effects page
devloglogan Feb 28, 2025
46471a1
Document `fgcolor` and `bgcolor` highlight padding in BBCode in RichT…
Calinou Mar 17, 2025
6b576a7
Merge pull request #10766 from Kuraiou/patch-1
Kuraiou Mar 17, 2025
cce8630
Merge pull request #10727 from devloglogan/asymmetrical-fov-doc
skyace65 Mar 18, 2025
49b3281
Update Enum names, improve enum member names, and add related suggestion
Lexyth Mar 18, 2025
7b7952a
Clarify type-safety of as
Lexyth Mar 18, 2025
5a46a02
Fix misplaced bad example
Lexyth Mar 18, 2025
58c9fdb
Clarify null-safety vs type-safety
Lexyth Mar 23, 2025
0140310
Fix good/bad example order
Lexyth Mar 23, 2025
4b04e65
Remove Good example title from as keyword example
Lexyth Mar 23, 2025
8609443
Update format
Lexyth Mar 23, 2025
571a85d
Update line length
Lexyth Mar 23, 2025
ab5dd51
Fix typo in instancing.rst
jannikbertram Mar 23, 2025
1966e9a
Update gdextension_c_example.rst
austin226 Mar 23, 2025
02311e5
Update doctest links from onqtam/doctest to doctest/doctest
larouxn Mar 24, 2025
f037202
Fix typo in Release policy
Calinou Mar 24, 2025
ce31d17
Merge pull request #10796 from Calinou/release-policy-fix-typo
skyace65 Mar 24, 2025
b74fda2
Merge pull request #10792 from austin226/patch-3
skyace65 Mar 24, 2025
c73a7b0
Merge pull request #10791 from jannikbertram/patch-1
skyace65 Mar 25, 2025
4a52813
Merge pull request #10794 from larouxn/update_doctest_repo_links
skyace65 Mar 25, 2025
bf27bf2
Fix URL check errors
skyace65 Mar 26, 2025
e263ffd
Merge pull request #10803 from skyace65/FixURLCheck
skyace65 Mar 26, 2025
2ec67eb
Merge pull request #10782 from Lexyth/patch-4
skyace65 Mar 26, 2025
a68d615
Update data_preferences.rst
tredstart Mar 27, 2025
6f515e9
Update tutorials/best_practices/data_preferences.rst
tredstart Mar 27, 2025
8f2068e
Update images and clarify instructions
Piralein Mar 27, 2025
f044c7c
Fix C# example about interpolating with quaternions
raulsntos Mar 27, 2025
2d81a29
Merge pull request #10808 from raulsntos/dotnet/using_transforms
skyace65 Mar 28, 2025
da75dd1
Merge pull request #10763 from Calinou/internal-rendering-architectur…
skyace65 Mar 28, 2025
8c29424
Adjust transform image and convert to WebP
BLooperZ Mar 28, 2025
5bf9ef3
CI: Check URLs on schedule only to reduce false positives
Calinou Mar 28, 2025
acb16ee
Remove duplicate paragraph
ncksllvn Mar 28, 2025
bba9563
Merge pull request #10811 from Calinou/ci-check-urls-on-schedule-only
skyace65 Mar 30, 2025
848476d
Merge pull request #10770 from BLooperZ/axes_colors
skyace65 Mar 30, 2025
9924a69
Merge pull request #10813 from ncksllvn/ncksllvn-getting-started-update
skyace65 Mar 30, 2025
c4c6d35
Link to class reference for each platform that can be exported to
Calinou Mar 31, 2025
a04295e
Update OpenXR Settings page
skyace65 Mar 30, 2025
907243f
Update two XR tools pages
skyace65 Mar 23, 2025
a907b23
Merge pull request #10822 from Calinou/exporting-link-class-reference
skyace65 Apr 1, 2025
09cf8c9
Merge pull request #10775 from Calinou/bbcode-in-richtextlabel-fgcolo…
skyace65 Apr 1, 2025
d0f4813
Added a hyperlink (#10799)
YoucefBoursali Apr 1, 2025
eb2b940
update "Add Library" to "New Library"
NNate1 Apr 1, 2025
e58e30a
Merge pull request #10826 from NNate1/getting-started-3d-game-charact…
skyace65 Apr 1, 2025
e289b92
[First 3D Game] update Pivot.look_at to Pivot.basis, follow up to 295…
NNate1 Apr 1, 2025
a26b51f
Fix outdated notice about reflection probes not being supported in Co…
Calinou Apr 2, 2025
17903a7
Merge pull request #10830 from Calinou/reflection-probes-compatibilit…
skyace65 Apr 3, 2025
bd52c22
Add middleware section to consoles page and clean up some outdated text
clayjohn Apr 2, 2025
80ff166
Merge pull request #10829 from NNate1/getting-started-3d-game-charact…
skyace65 Apr 3, 2025
d379450
Update c_sharp_exports.rst
DeerUwU Apr 3, 2025
1d3bf85
Merge pull request #10804 from jmacdotorg/about-license
jmacdotorg Apr 3, 2025
ba72293
Update spatial_shader.rst
pixcai Apr 4, 2025
e44bbb6
Merge pull request #10762 from Calinou/mesh-automatic-instancing
skyace65 Apr 4, 2025
3b7fa3f
removed outdated note on .app not being supported, and minor improvem…
AdriaandeJongh Apr 5, 2025
fd14417
Merge pull request #10807 from Piralein/update-3d-player-img
skyace65 Apr 5, 2025
93963ab
Document support for 2D per-instance uniforms in Shading language (#1…
Calinou Apr 5, 2025
1a9c81e
Merge pull request #10740 from DevPoodle/compute-shader
skyace65 Apr 6, 2025
eb82440
Merge pull request #10828 from clayjohn/console-middleware
skyace65 Apr 6, 2025
7329907
Merge pull request #10834 from pixcai/patch-1
skyace65 Apr 6, 2025
1335f38
Merge pull request #10781 from Lexyth/patch-3
skyace65 Apr 6, 2025
8343a18
Merge pull request #10832 from DeerUwU/patch-1
skyace65 Apr 6, 2025
62a4e95
Merge pull request #10837 from AdriaandeJongh/remove-macos-app-format…
skyace65 Apr 6, 2025
376d525
Update navigation_using_navigationagents.rst
Overkane Apr 7, 2025
b4d0968
Merge pull request #10790 from skyace65/XR-Tools-Update
mhilbrunner Apr 7, 2025
2801631
Merge pull request #10819 from skyace65/OpenXR-Settings
mhilbrunner Apr 7, 2025
7fd2c76
Bump sphinxext-opengraph from 0.9.1 to 0.10.0
dependabot[bot] Apr 7, 2025
ed65cec
Merge pull request #10841 from Overkane/patch-1
skyace65 Apr 7, 2025
1d103b1
C#: Remove outdated bits defines
raulsntos Apr 8, 2025
dc5ef25
Clarify resources.rst
hewplayfair Apr 8, 2025
7bc1c2b
Merge pull request #10846 from raulsntos/dotnet/bits-defines
skyace65 Apr 8, 2025
031fd83
Merge pull request #10842 from godotengine/dependabot/pip/sphinxext-o…
skyace65 Apr 8, 2025
16f672e
Merge pull request #10724 from dresswithpockets/patch-1
skyace65 Apr 9, 2025
925b967
Merge pull request #10657 from tetrapod00/update-intro-games
skyace65 Apr 9, 2025
a15f86b
Merge branch 'master' into patch-1
skyace65 Apr 9, 2025
a589392
Merge pull request #9211 from fariazz/patch-1
skyace65 Apr 9, 2025
042e68e
Merge pull request #10847 from hewplayfair/patch-1
skyace65 Apr 9, 2025
cf33eb6
Merge pull request #10806 from tredstart/master
skyace65 Apr 9, 2025
6ced0f9
Change "allow to" to "allow you to"
ManOfDuck Apr 9, 2025
e87d427
Merge pull request #10851 from ManOfDuck/patch-1
skyace65 Apr 10, 2025
ab6e738
Fix @export_custom hint format in gdscript_exports.rst
PQL87 Apr 10, 2025
2f4ad61
Update the @export_custom example in gdscript_exports.rst
PQL87 Apr 11, 2025
19cabbc
Merge pull request #10853 from starsJuly/patch-1
skyace65 Apr 11, 2025
6eae590
Document reading project settings with overrides taken into account i…
Calinou Jan 8, 2025
092529f
Merge pull request #10488 from Calinou/feature-tags-get-setting-with-…
skyace65 Apr 11, 2025
f31a4ac
docs: Add a note about the effect of `@export`. (#10560)
elenakrittik Apr 11, 2025
fb1f3c8
Included note about requirement for class_name for a resource to show…
j4d3blooded Apr 11, 2025
8c18714
Merge pull request #10780 from Lexyth/patch-2
skyace65 Apr 11, 2025
7f82289
Update the getting started 3d tutorial for godot 4.x
russellsanborn Aug 2, 2024
4fc8c58
Merge pull request #9698 from russellsanborn/3d-squash-the-creeps-4x
skyace65 Apr 12, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/workflows/check_urls.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
name: 🌐 Check URLs
on:
push:
pull_request:
schedule:
# Every day at 18:00 UTC.
# Every Friday at 16:27 UTC.
# URLs can decay over time. Setting up a schedule makes it possible to be warned
# about dead links as soon as possible.
- cron: "0 18 * * *"
- cron: "27 16 * * FRI"

jobs:
check-urls:
Expand Down
2 changes: 2 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ tcp:\/\/.*
.*asecuritysite\.com.*
.*intel\.com.*
.*reddit\.com.*
.*inkscape.org.*
.*computerhope.com*

# Don't check URLs from these websites due to frequent rate limits (error 429) or timeouts.
.*adobe\.com.*
Expand Down
6 changes: 3 additions & 3 deletions about/release_policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,9 @@ When is the next release out?
While Godot contributors aren't working under any deadlines, we strive to
publish minor releases relatively frequently.

In particular, after the very length release cycle for 4.0, we are pivoting to
a faster paced development workflow, 4.1 released 4 months after 4.0, and 4.2
released 4 months after 4.1
In particular, after the very long release cycle for 4.0, we are pivoting to
a faster-paced development workflow, 4.1 released 4 months after 4.0, and 4.2
released 4 months after 4.1.

Frequent minor releases will enable us to ship new features faster (possibly
as experimental), get user feedback quickly, and iterate to improve those
Expand Down
1 change: 1 addition & 0 deletions community/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Text tutorials
- `GDScript website by Andrew Wilkes <https://gdscript.com>`__
- `Godot Recipes by KidsCanCode <https://kidscancode.org/godot_recipes/4.x/>`__
- `Godot Tutorials by SomethingLikeGames <https://www.somethinglikegames.de/en/tags/godot-engine/>`__
- `GameDev Academy by Zenva <https://gamedevacademy.org/category/godot-tutorials/godot-4/>`__
- `Game Dev Artisan website <https://gamedevartisan.com/>`__
- `Night Quest Games Blog <https://www.nightquestgames.com/blog-articles/>`__

Expand Down
6 changes: 6 additions & 0 deletions contributing/development/configuring_an_ide/visual_studio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ by `Microsoft <https://microsoft.com>`_ that's free for individual use or non-co
It has many useful features, such as memory view, performance view, source
control and more.

.. note::

This documentation is for contributions to the game engine, and not using
Visual Studio as a C# editor. To code C# in an external editor, see
:ref:`the C# guide to configure an external editor <doc_c_sharp_setup_external_editor>`.

Importing the project
---------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
Visual Studio Code
==================

.. note::

This documentation is for contributions to the game engine, and not using
Visual Studio Code as a C# or GDScript editor. To code C# or GDScript in an external editor, see
:ref:`the C# guide to configure an external editor <doc_c_sharp_setup_external_editor>`.

`Visual Studio Code <https://code.visualstudio.com>`_ is a free cross-platform code editor
by `Microsoft <https://microsoft.com>`_ (not to be confused with :ref:`doc_configuring_an_ide_vs`).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -426,13 +426,7 @@ release.
2D light rendering is performed in a single pass to allow for better performance
with large amounts of lights.

.. UPDATE: Planned feature. When Forward+ and Mobile feature 2D batching,
.. update this.

The Forward+ and Mobile rendering methods don't feature 2D batching yet, but
it's planned for a future release.

The Compatibility renderer features 2D batching to improve performance, which is
All rendering methods feature 2D batching to improve performance, which is
especially noticeable with lots of text on screen.

MSAA can be enabled in 2D to provide "automatic" line and polygon antialiasing,
Expand All @@ -456,9 +450,10 @@ used to calculate particle collisions in 2D.
Batching and instancing
~~~~~~~~~~~~~~~~~~~~~~~

In the Forward+ renderer, Vulkan instancing is used to group rendering
of identical objects for performance. This is not as fast as static mesh
merging, but it still allows instances to be culled individually.
In the Forward+ renderer, Vulkan instancing is used to group rendering of
identical opaque or alpha-tested objects for performance. (Alpha-blended objects
are never instanced.) This is not as fast as static mesh merging, but it still
allows instances to be culled individually.

Light, decal and reflection probe rendering
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions contributing/development/core_and_modules/unit_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Unit testing
============

Godot Engine allows to write unit tests directly in C++. The engine integrates
the `doctest <https://github.com/onqtam/doctest>`_ unit testing framework which
the `doctest <https://github.com/doctest/doctest>`_ unit testing framework which
gives ability to write test suites and test cases next to production code, but
since the tests in Godot go through a different ``main`` entry point, the tests
reside in a dedicated ``tests/`` directory instead, which is located at the root
Expand Down Expand Up @@ -208,7 +208,7 @@ for more complex ones if you think that it deserves a better explanation.

.. seealso::

`doctest: Assertion macros <https://github.com/onqtam/doctest/blob/master/doc/markdown/assertions.md>`_.
`doctest: Assertion macros <https://github.com/doctest/doctest/blob/master/doc/markdown/assertions.md>`_.

Logging
~~~~~~~
Expand Down Expand Up @@ -236,7 +236,7 @@ output can be redirected to an XML file:

.. seealso::

`doctest: Logging macros <https://github.com/onqtam/doctest/blob/master/doc/markdown/logging.md>`_.
`doctest: Logging macros <https://github.com/doctest/doctest/blob/master/doc/markdown/logging.md>`_.

Testing failure paths
~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion contributing/development/editor/creating_icons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Color conversion for light editor themes

If the user has configured their editor to use a light theme, Godot will
convert the icon's colors based on a
`set of predefined color mappings <https://github.com/godotengine/godot/blob/4.0.2-stable/editor/editor_themes.cpp#L60-L160>`__.
`set of predefined color mappings <https://github.com/godotengine/godot/blob/master/editor/themes/editor_color_map.cpp>`__.
This is to ensure the icon always displays with a sufficient contrast rate.
Try to restrict your icon's color palette to colors found in the list above.
Otherwise, your icon may become difficult to read on a light background.
Expand Down
71 changes: 71 additions & 0 deletions contributing/documentation/docs_contribution_checklist.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
.. _docs_contribution_checklist:

Documentation contribution checklist
====================================

This page is a summary of the guidelines to follow when contributing to the
documentation. Before you press that **Create pull request** button on GitHub,
read over this list to double check if you missed anything.

You don't need to read all the guidelines here in order to start contributing.
If you do miss something, it will be pointed out during review. However,
following the guidelines you are aware of as best you can will help speed up the
review process.

Writing style
-------------

:ref:`See here. <doc_docs_writing_guidelines_clear_english_rules>`

- Use the active voice.
- Use precise action verbs.
- Avoid verbs that end in -ing.
- Remove unnecessary adverbs and adjectives.
- Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however.
- Use explicit references.
- Use 's to show possession.
- Use the Oxford comma.

Code examples
-------------

- Use dynamic typing. :ref:`See here. <doc_docs_writing_guidelines_dynamic_typing>`
- Use real, practical examples. Avoid ``foo`` / ``bar`` examples. :ref:`See here. <doc_docs_writing_guidelines_real_world_code_example>`

Manual style and formatting
---------------------------

- Use common vocabulary for the editor interface. :ref:`See here. <doc_docs_writing_guidelines_common_vocabulary>`
- Use ``:kbd:`` for keyboard shortcuts. :ref:`See here. <doc_docs_writing_guidelines_keyboard_shortcuts>`
- Literals use ``code style``. :ref:`See here. <doc_docs_writing_guidelines_literals>`
- Classes link to the class reference once, then use ``ClassName`` for the rest
of the page.
Methods and properties link to the class ref once, then use ``PropertyName``
for the rest of the page. :ref:`See here. <doc_docs_writing_guidelines_class_properties_methods>`
- Editor UI, like menus, windows, and editor navigation paths, use
``Bold Style``. :ref:`See here. <doc_docs_writing_guidelines_editor_ui>`
- Link to project settings when referencing them. :ref:`See here. <doc_docs_writing_guidelines_project_settings>`
- Text is manually wrapped to 80-100 characters. :ref:`See here. <doc_docs_writing_guidelines_manually_wrapping_lines>`
- No trailing whitespace at the end of lines.
- Most of the time, avoid mentioning a specific Godot version. :ref:`See here. <doc_docs_writing_guidelines_specific_version>`

Images and videos
-----------------

- New (and updated) images are in WebP format. :ref:`See here. <doc_docs_image_guidelines_format_conversion>`
- Editor screenshots are cropped. :ref:`See here. <doc_docs_image_guidelines_cropping>`
- Images larger than 1080p or 300kb are scaled down. :ref:`See here. <doc_docs_image_guidelines_scaling_down>`
- Outlines in images use ``fffb44`` yellow. :ref:`See here. <doc_docs_image_guidelines_outlines>`
- Videos use the ``:autoplay:``, ``:loop:``, and ``:muted:`` tags. :ref:`See here. <doc_docs_image_guidelines_videos>`

GitHub
------

- The PR title starts with a word like ``Fix``, ``Add``, ``Update``,
``Clarify``, or ``Improve``.
- If the PR closes an issue, link to the issue with one of GitHub's
`keywords <https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests>`__:
``closes``, ``fixes``, or ``resolves``, in the text of the PR.
- Ideally, PR contains a single commit. However, multiple commits can be
:ref:`squashed <doc_pr_workflow_rebase>` later.

10 changes: 10 additions & 0 deletions contributing/documentation/docs_image_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ dramatically increases file size. If you're taking screenshots on a higher
resolution screen the screenshot should be scaled down. There are instructions
on how to do this later on this page.

.. _doc_docs_image_guidelines_format_conversion:

Format conversion
~~~~~~~~~~~~~~~~~

Expand All @@ -59,6 +61,8 @@ it may have the ability to open an image then save it as a WebP file.
GIFs should be avoided. Their compression is inefficient and they only support
a 256-color palette with 1-bit transparency.

.. _doc_docs_image_guidelines_cropping:

Cropping
~~~~~~~~

Expand Down Expand Up @@ -94,6 +98,8 @@ If you make a mistake and overcrop don't worry, cropping is non-destructive in
Krita and can be adjusted. Click on the image with your cropping tool still selected
and the controls will return.

.. _doc_docs_image_guidelines_scaling_down:

Scaling down an image
~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -119,6 +125,8 @@ If it's still over 300KB change to lossy compression and slowly increase the com
300KB. If this results in noticeable compression artifacts using less compression is fine, even if the file
size is bigger.

.. _doc_docs_image_guidelines_outlines:

Outlines, arrows and text
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -160,6 +168,8 @@ Where ``documentation_image.webp`` would be changed to the name of the image you
created. Name your images in a way that makes their meaning clear, possibly with
a prefix that makes their relationship to a documentation page explicit.

.. _doc_docs_image_guidelines_videos:

Videos
------

Expand Down
22 changes: 22 additions & 0 deletions contributing/documentation/docs_writing_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ There are 3 rules to describe classes:
See the :ref:`content guidelines <doc_content_guidelines>` for information
on the types of documentation you can write in the official documentation.

.. _doc_docs_writing_guidelines_clear_english_rules:

7 rules for clear English
-------------------------

Expand Down Expand Up @@ -283,6 +285,8 @@ element of a list with more than two elements.
How to write methods and classes
--------------------------------

.. _doc_docs_writing_guidelines_dynamic_typing:

Dynamic vs static typing
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -335,6 +339,8 @@ The exception is topics that explain static typing concepts to users.
var choice = randi() % size
return arguments[choice]

.. _doc_docs_writing_guidelines_real_world_code_example:

Use real-world code examples where appropriate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -452,6 +458,7 @@ documentation and in Godot, it will display like ``this``. When you edit XML
files in the Godot repository, replace existing arguments written like 'this' or
\`this\` with ``[code]this[/code]``.

.. _doc_docs_writing_guidelines_common_vocabulary:

Common vocabulary to use in Godot's documentation
-------------------------------------------------
Expand Down Expand Up @@ -487,6 +494,8 @@ class names, which you can't fold, are ``Classes`` e.g. the
``properties``. E.g. ``position`` or ``modulate color`` are both
``properties``.

.. _doc_docs_writing_guidelines_keyboard_shortcuts:

Keyboard shortcut guidelines
----------------------------

Expand All @@ -507,6 +516,7 @@ examples with the ``:kbd:`` tag left as-is for better visibility:
- Press ``:kbd:`Space``` and hold the left mouse button to pan in the 2D editor.
- Press ``:kbd:`Shift + Up Arrow``` to move the node upwards by 8 pixels.

.. _doc_docs_writing_guidelines_manual_style:

Manual style guidelines
-----------------------
Expand Down Expand Up @@ -567,6 +577,8 @@ is fine too.
- Godot uses *nodes* with *scripts* in a *scene tree*.
- Godot uses **nodes** with **scripts** in a **scene tree**.

.. _doc_docs_writing_guidelines_literals:

Literals
~~~~~~~~

Expand All @@ -576,6 +588,8 @@ Use ``code style`` for literal values. Literals include:
- Float literals like ``0.0``, ``0.5``, ``-2.0``, or ``100.0``
- Vector literals like ``(0.0, 0.0)``, ``(0.5, -0.5, 0.5)``, or ``(1.0, 2.0, 3.0, 4.0)``.

.. _doc_docs_writing_guidelines_class_properties_methods:

Classes, properties, and methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -591,6 +605,8 @@ link.
When discussing properties in the context of the inspector, use **bold style**
instead.

.. _doc_docs_writing_guidelines_editor_ui:

Editor UI
~~~~~~~~~

Expand All @@ -613,6 +629,8 @@ reader must navigate. Use ``>`` as a separator. You can omit ellipses in menu na
.. note:: Sometimes, ``->`` or ``→`` is used as a separator. This is nonstandard.
Replace it with ``>`` if you are already making changes to a section.

.. _doc_docs_writing_guidelines_project_settings:

Project settings
~~~~~~~~~~~~~~~~

Expand All @@ -625,6 +643,8 @@ rendered, prefer splitting the setting name and the section when the link is lon
- In the project settings under **Application > Run**, set :ref:`Max FPS<class_ProjectSettings_property_application/run/max_fps>` to ``60``.
- In **Project Settings > Application > Run**, set :ref:`Max FPS<class_ProjectSettings_property_application/run/max_fps>` to ``60``.

.. _doc_docs_writing_guidelines_manually_wrapping_lines:

Manually wrapping lines
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -710,6 +730,8 @@ See the `Sphinx documentation <https://www.sphinx-doc.org/en/master/usage/restru
and the `reStructuredText documentation <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections>`__
for more information.

.. _doc_docs_writing_guidelines_specific_version:

When to refer to a specific Godot version
-----------------------------------------

Expand Down
1 change: 1 addition & 0 deletions contributing/documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ documentation.
content_guidelines
docs_writing_guidelines
docs_image_guidelines
docs_contribution_checklist

Writing the manual
------------------
Expand Down
Loading
Loading