Contributing to the class reference

classes section of the documentation and in the Godot editor, from the help menu. In the class reference, some methods, variables, and signals lack descriptions. Others changed with recent releases and need updates. The developers can’t write the entire reference on their own. Godot needs you, and all of us, to contribute. Important: If you plan to make large changes, you should create an issue on the godot-docs repository or comment on an existing issue. Doing so lets others know you’re already taking care of a given class. See also here. Pull request workflow page. Editor and docs localization. video tutorial on YouTube. See also here. doc/classes/. Note modules/<module_name>/doc_classes/ directory instead. Warning .rst files in the online documentation, hosted in the godot-docs repository. Warning Unless you make minor changes, like fixing a typo, we do not recommend using the GitHub web editor to edit the class reference’s XML. It lacks features to edit XML well, like keeping indentations consistent, and it does not allow amending commits based on reviews. How to edit class XML.

Updating the documentation template

doc/classes/. 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

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.