Godot 4.0 Documentation Sprint

By: Max Hilbrunner 11 January 2023

With the release candidate for Godot Engine 4.0 being just around the corner, we want to make sure that the community is fully prepared and can dive right into it as soon as the new version is available. To that end, this is a call to action — to help in completing the documentation for Godot 4.

Everyone is welcome! New contributors, we’re happy to help you get started. Seasoned participants, please take this chance to document all the awesome work you and your teammates have been doing on Godot. Helping each other is highly encouraged, filling the gaps and reviewing contributions to make sure they are factual and well written.

We have many new features, and documentation is going to be the first place people look at to figure them out. If you don’t have a lot of time or lack writing skills, don’t worry! The documentation team is happy to help out, just give us something to work with be it a class reference addition or a new tutorial for the manual.

How to participate in the docs sprint

  • What? Calling on all members of the Godot community to help complete the docs for the next major release. We’re happy to help, give tips, onboard new documentation contributors, and to get pull requests reviewed and merged! Let’s get stuff done.

  • When? Starting right now up until the end of this month, January 31st.

  • Who? Everyone is welcome. Whether you’re new to contributing, or returning to the project, there’s enough to do for everyone.

  • How to start? The writing documentation page in the documentation is a good start. If you have any questions, get in touch with the maintainers in the #documentation channel on the Contributors Chat. You can see the whole documentation team on the Teams page. If in doubt, ping Max (@mhilbrunner).

  • Where to start? Have a look at open issues in the documentation repository, as well as the main repository. You can also check the areas of the engine you’re most familiar with. See if the class reference is updated and complete for that area, whether the tutorials need to be updated, and so on.

  • Gotchas. The Class Reference is maintained in the main repository and needs to be edited there. See this article for more information.

Thanks to everyone who contributes and helps make this project better for everyone. Let’s end this announcement with a video by Nathan of GDQuest fame on how to start contributing to Godot’s docs! Watch it here.