Wskazówki do dokumentacji

This page describes the rules to follow if you want to contribute to Godot Engine by writing or reviewing documentation, or by translating existing documentation. Also have a look at README of the godot-docs GitHub repository and the docs front page on what steps to follow and how to contact the docs team.

Jak wspierać projekt

Tworzenie lub modyfikowanie stron dokumentacji odbywa się głównie poprzez repozytorium godot-docs GitHub. Dokumentacja HTML (lub PDF i EPUB) jest generowana z plików .rst (język znaczników reStructuredText) z tego repozytorium. Modyfikacja tych stron w pull requeście i połączenie go z gałęzią master, spowoduje przebudowę dokumentacji online.

Zobacz także

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.

The README.md file contains all the information you need to get you started, please read it. In particular, it contains some tips and tricks and links to reference documentation about the reStructuredText markup language.

Ostrzeżenie

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: Wspieranie Dokumentacji Klasy.

Co tworzy dobrą dokumentację?

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 Porady dotyczące pisania dokumentacji.

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).

Tytuły

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

.. _doc_insert_your_title_here:

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

The reference allows to link 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:

  • Insert your title here

I przykład złego zastosowania:

  • Insert Your Title Here

Tylko projekty, ludzie i nazwy węzłów klas są pisane wielką literą.

Tłumaczenie istniejących stron

You can help to translate the official Godot documentation on our Hosted Weblate.

Translation state

Jest również oficjalne repozytorium Godota I18N. gdzie możesz śledzić które dane zostały ostatnio zsynchronizowane.

Licencja

This documentation and every page it contains is published under the terms of the Creative Commons Attribution 3.0 license (CC-BY-3.0), with attribution to „Juan Linietsky, Ariel Manzur and the Godot community”.

Pisząc dokumentację w repozytorium GitHub, zgadzasz się na dystrybuowanie twoich zmian z powyższą licencją.