mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-09 21:29:08 +00:00
Hugo Locurcio
95fb178429
This allows users to leave comments on pages that don't have `:allow_comments: False` somewhere in the page's source. Both manual and class reference pages can receive comments. Index pages cannot have comments, as discussion should occur on "leaf" pages. GitHub Discussions is used as a backend on the same repository. This means that Discussions *must* be enabled on godotengine/godot-docs before this commit is merged to `master`. Users can choose to use the "Custom" watch mode if they don't want to get notifications for discussion updates, but still get notifications for issue and pull request updates. User comments are intended to be used for the following purposes: - Add a clarification or correct something in the documentation, without having to open a pull request. Contributors are encouraged to take a look at discussions from time to time, and see if there's information worth incorporating in the pages themselves. Don't forget to reply to the comment when doing so :) - Mention a workaround for a common issue. - Link to useful third-party resources that are relevant to the current page, such as tutorials or add-ons. User comments should *not* be used for technical support. Other community platforms should be used for that. Page-to-discussion matching is done using the `pagename` Sphinx variable, which is independent of the Godot version and documentation language. Being independent of the Godot version allows keeping old comments when the Godot version changes, while also allowing users from `/stable` and `/4.1` to "see" each other in discussions. See https://giscus.app for more information.
71 lines
1.8 KiB
ReStructuredText
71 lines
1.8 KiB
ReStructuredText
:allow_comments: False
|
|
|
|
.. _doc_contributing_writing_documentation:
|
|
|
|
Writing documentation
|
|
=====================
|
|
|
|
We always need help to improve the documentation, be it the class reference or
|
|
the manual. Below, you can find our content and writing guidelines and
|
|
concrete guides to make changes to the documentation.
|
|
|
|
Be sure to also check the :ref:`workflow guidelines <doc_contributing_workflow>`,
|
|
especially if you're new to using Git or GitHub.
|
|
|
|
Guidelines
|
|
----------
|
|
|
|
Here are the principles and guidelines we strive to follow to write accessible
|
|
documentation.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: toc-contributing-writing-guidelines
|
|
|
|
content_guidelines
|
|
docs_writing_guidelines
|
|
docs_image_guidelines
|
|
|
|
Writing the manual
|
|
------------------
|
|
|
|
These articles explain how to contribute to this very documentation, and
|
|
how to build the online version locally for testing.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: toc-contributing-documentation
|
|
|
|
contributing_to_the_documentation
|
|
building_the_manual
|
|
|
|
Class reference guides
|
|
----------------------
|
|
|
|
The pages below focus on the class reference.
|
|
|
|
As the reference is included in the Godot editor, its source files are part of
|
|
the `godot repository <https://github.com/godotengine/godot>`_. We use XML files
|
|
to write it, so the process to contribute to the class reference differs from
|
|
writing the online manual.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: toc-contributing-class-reference
|
|
|
|
updating_the_class_reference
|
|
class_reference_primer
|
|
|
|
Translating the documentation
|
|
-----------------------------
|
|
|
|
The community is always working hard on making Godot and its documentation
|
|
available to more people. Localizing the documentation is a colossal and ongoing
|
|
effort you can be part of.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: toc-contributing-localization
|
|
|
|
editor_and_docs_localization
|