Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
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
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
Manual style and formatting
Use common vocabulary for the editor interface. See here.
Use
:kbd:for keyboard shortcuts. See here.Literals use
code style. See here.Classes link to the class reference once, then use
ClassNamefor the rest of the page. Methods and properties link to the class ref once, then usePropertyNamefor the rest of the page. See here.Editor UI, like menus, windows, and editor navigation paths, use
Bold Style. See here.Link to project settings when referencing them. See here.
Text is manually wrapped to 80-100 characters. See here.
No trailing whitespace at the end of lines.
Most of the time, avoid mentioning a specific Godot version. See here.