Diretrizes de documentação

Essa página descreve as regras a seguir se você quiser contribuir para o Godot Engine escrevendo ou revendo documentação, ou traduzindo a documentação existente. Também dê uma olhada no README da godot-docs GitHub repository and the docs front page on what steps to follow and how to contact the docs team.

Como contribuir

Creating or modifying documentation pages is mainly done via the godot-docs GitHub repository. The HTML (or PDF and EPUB) documentation is generated from the .rst files (reStructuredText markup language) in that repository. Modifying those pages in a pull request and getting it merged will trigger a rebuild of the online documentation.

Ver também

For details on Git usage and the pull request workflow, please refer to the Pull request workflow page. Most of what it describes regarding the main godotengine/godot repository is also valid for the docs repository.

Aviso

The class reference's source files are in the Godot engine repository. We generate the Godot API section of this documentation from them. If you want to update the description of a class, its methods, or properties, read Contribuindo para as referências de classe.

Aviso

If you want to edit the API reference, please note that it should not be done in the godot-docs repository. Instead, you should edit the doc/classes/* XML files of Godot's main repository. These files are then later used to generate the in-editor documentation as well as the API reference of the online docs. Read more here: Contribuindo para as referências de classe.

The 'Edit on GitHub' link

If you're reading documentation on docs.godotengine.org, you'll see an Edit on GitHub hyperlink at the top right of the page. Once you've created a GitHub account, you can propose changes to a page you're reading as follows:

1. Click the Edit on GitHub button.

2. On the GitHub page you're taken to, click the pencil icon in the top-right corner near the Raw, Blame and History buttons. It has the tooltip "Edit the file in a fork of this project".

3. Complete all the edits you want to make for that page.

4. Summarize the changes you made in the form at the bottom of the page and click the button labelled Propose file change when done.

5. On the following screens, click the Create pull request button until you see a message like Username wants to merge 1 commit into godotengine:master from Username:patch-6.

6. A reviewer will evaluate your changes and incorporate them into the docs if they're acceptable. You might also be asked to make modifications to your changes before they're included.

O que faz uma boa documentação?

Documentation should be well written in plain English, using well-formed sentences and various levels of sections and subsections. It should be clear and objective. Also, have a look at the Diretrizes de redação de documentos.

We differentiate tutorial pages from other documentation pages by these definitions:

• Tutorial: a page aiming at explaining how to use one or more concepts in the editor or scripts in order to achieve a specific goal with a learning purpose (e.g. "Making a simple 2d Pong game", "Applying forces to an object").

• Documentation: a page describing precisely one and only one concept at a time, if possible exhaustively (e.g. the list of methods of the Sprite class, or an overview of the input management in Godot).

You are free to write the kind of documentation you wish, as long as you respect the following rules (and the ones on the repo).

Títulos

Always begin pages with their title and a Sphinx reference name:

.. _doc_insert_your_title_here:

Insert your title here
======================

The reference allows linking to this page using the :ref: format, e.g. :ref:`doc_insert_your_title_here` would link to the above example page (note the lack of leading underscore in the reference).

Also, avoid American CamelCase titles: title's first word should begin with a capitalized letter, and every following word should not. Thus, this is a good example:

• Insira seu título aqui

And this is a bad example:

• Insira seu título aqui

Only project, people and node class names should have capitalized first letter.

Traduzindo páginas existentes

Você pode ajudar a traduzir a documentação oficial do Godot em nosso Hosted Weblate.

Também há o Repositório Godot i18n oficial onde você pode ver quando os dados foram sincronizados pela última vez.

Licença

Todo o conteúdo desta documentação está sob a Creative Commons Attribution 3.0 license (CC-BY 3.0), com atribuição à "Juan Linietsky, Ariel Manzur and the Godot community".

Ao contribuir para a documentação no repositório do GitHub, você concorda que suas modificações são distribuídas sob esta licença.