diff --git a/documentation/guidelines/index.rst b/documentation/guidelines/index.rst index b42d310..5cb830f 100644 --- a/documentation/guidelines/index.rst +++ b/documentation/guidelines/index.rst @@ -2,8 +2,8 @@ .. _doc_contributing_writing_documentation: -Guidelines -========== +Documentation guidelines +======================== Here are the principles and guidelines we strive to follow to write accessible documentation. diff --git a/documentation/overview.rst b/documentation/overview.rst index fac76f5..2a6c6d2 100644 --- a/documentation/overview.rst +++ b/documentation/overview.rst @@ -1,5 +1,5 @@ -Overview -======== +Documentation overview +====================== 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 @@ -19,7 +19,7 @@ There are two separate resources referred to as "documentation" in Godot: for more details. - **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 `_. Its contents are generated from plain text files in the reStructured Text (rst) format, to which you can contribute via pull requests on the `godot-docs `_ GitHub repository. diff --git a/index.rst b/index.rst index ea14a1b..cd38c10 100644 --- a/index.rst +++ b/index.rst @@ -142,7 +142,7 @@ Community support .. toctree:: :hidden: :maxdepth: 1 - :caption: Sharing ideas and proposing changes + :caption: Sharing ideas :name: sec-proposals proposals/first_steps diff --git a/proposals/first_steps.rst b/proposals/first_steps.rst index eac0745..842bedb 100644 --- a/proposals/first_steps.rst +++ b/proposals/first_steps.rst @@ -1,4 +1,4 @@ -First steps -=========== +How to share ideas +================== TODO diff --git a/pull_request_review/guidelines.rst b/pull_request_review/guidelines.rst index 7a94f09..aecbd4e 100644 --- a/pull_request_review/guidelines.rst +++ b/pull_request_review/guidelines.rst @@ -1,7 +1,7 @@ .. _doc_pr_review_guidelines: -Guidelines -========== +Review Guidelines +================= Code review and testing ----------------------- diff --git a/reporting_issues/first_steps.rst b/reporting_issues/first_steps.rst index 3edcff8..b2648f0 100644 --- a/reporting_issues/first_steps.rst +++ b/reporting_issues/first_steps.rst @@ -1,7 +1,7 @@ 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 issues discovered in stable releases, so that they can be fixed in the development branch and in future maintenance releases. diff --git a/triage/about.rst b/triage/about.rst index 3f21232..cbbc417 100644 --- a/triage/about.rst +++ b/triage/about.rst @@ -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! Your help means a lot!