mirror of
https://github.com/godotengine/godot-contributing-docs.git
synced 2026-01-06 06:10:24 +03:00
Change a few titles and minor text.
This commit is contained in:
@@ -2,8 +2,8 @@
|
|||||||
|
|
||||||
.. _doc_contributing_writing_documentation:
|
.. _doc_contributing_writing_documentation:
|
||||||
|
|
||||||
Guidelines
|
Documentation guidelines
|
||||||
==========
|
========================
|
||||||
|
|
||||||
Here are the principles and guidelines we strive to follow to write accessible
|
Here are the principles and guidelines we strive to follow to write accessible
|
||||||
documentation.
|
documentation.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
Overview
|
Documentation overview
|
||||||
========
|
======================
|
||||||
|
|
||||||
We always need help to improve the documentation, be it the class reference or
|
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
|
the manual. Below, you can find our content and writing guidelines and
|
||||||
@@ -19,7 +19,7 @@ There are two separate resources referred to as "documentation" in Godot:
|
|||||||
for more details.
|
for more details.
|
||||||
|
|
||||||
- **The tutorials and engine documentation and its translations.**
|
- **The tutorials and engine documentation and its translations.**
|
||||||
This is the part you are reading now, which is distributed in the HTML format.
|
This is the part you can `find online <https://docs.godotengine.org/en/stable/>`_.
|
||||||
Its contents are generated from plain text files in the reStructured Text
|
Its contents are generated from plain text files in the reStructured Text
|
||||||
(rst) format, to which you can contribute via pull requests on the
|
(rst) format, to which you can contribute via pull requests on the
|
||||||
`godot-docs <https://github.com/godotengine/godot-docs>`_ GitHub repository.
|
`godot-docs <https://github.com/godotengine/godot-docs>`_ GitHub repository.
|
||||||
|
|||||||
@@ -142,7 +142,7 @@ Community support
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:hidden:
|
:hidden:
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:caption: Sharing ideas and proposing changes
|
:caption: Sharing ideas
|
||||||
:name: sec-proposals
|
:name: sec-proposals
|
||||||
|
|
||||||
proposals/first_steps
|
proposals/first_steps
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
First steps
|
How to share ideas
|
||||||
===========
|
==================
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
.. _doc_pr_review_guidelines:
|
.. _doc_pr_review_guidelines:
|
||||||
|
|
||||||
Guidelines
|
Review Guidelines
|
||||||
==========
|
=================
|
||||||
|
|
||||||
Code review and testing
|
Code review and testing
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
Getting started
|
Getting started
|
||||||
===============
|
===============
|
||||||
|
|
||||||
Another great way of contributing to the engine is to test development releases
|
A great way of contributing to the engine is to test development releases
|
||||||
or the development branch and to report issues. It is also helpful to report
|
or the development branch and to report issues. It is also helpful to report
|
||||||
issues discovered in stable releases, so that they can be fixed in
|
issues discovered in stable releases, so that they can be fixed in
|
||||||
the development branch and in future maintenance releases.
|
the development branch and in future maintenance releases.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
Introduction to Triage
|
Introduction to issue triage
|
||||||
======================
|
============================
|
||||||
|
|
||||||
So you are looking to help with bug triage? First of all, thank you!
|
So you are looking to help with bug triage? First of all, thank you!
|
||||||
Your help means a lot!
|
Your help means a lot!
|
||||||
|
|||||||
Reference in New Issue
Block a user