godotengine/godot-contributing-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-contributing-docs.git synced 2025-12-31 05:48:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a section for contributing to the contributing docs (this page).

Browse Source
This commit is contained in:
Lukas Tenbrink
2025-09-09 15:36:14 +02:00
parent 65db864b15
commit 274c0f0fb7
3 changed files with 67 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
documentation/contributing_to_the_contributing_docs.rst Normal file
View File

@@ -0,0 +1,64 @@
.. _doc_updating_the_contributing_docs:
Contributing to the contributing docs
=====================================
The contributing documentation documents how people can best contribute
to Godot. It is the website you are looking at right now!
As an important part of Godot, we'd like to see this documentation evolve
and improve alongside the rest of Godot. Community involvement is just as
welcome on this site as in the rest of Godot's documentation!
If you'd like to submit an idea for a change of guidelines or operations,
please consider proposing it as an `idea <_doc_contributing_ideas>`__
instead of attempting to change the docs directly.
Making changes to the contributing docs
=======================================
The information on this site are managed in a GitHub repository
(`github.com/godotengine/godot-contributing-docs <https://github.com/godotengine/godot-contributing-docs>`__).
You can contribute to this repository using our regular
`PR workflow <_doc_pr_workflow>`__. Please adhere to our
`documentation guidelines <_doc_documentation_guidelines>`__ when making
changes.
To get started quickly, visit any article on this site and click the "Edit
on GitHub" button in the top right of the page.
What kinds of information are documented here?
==============================================
This page is intended for people who are interested in contributing to
Godot. They should be able to quickly find out how they can contribute,
be guided to confidently make their first contributions, and be able to
find all the relevant guidelines to become proficient contributors.
It can be difficult to determine if any piece of information should be
documented here or elsewhere. Consider reading the following examples
to get an idea.
The following kinds of information **should** be documented here:
* The expected workflow for contributing to any area of Godot (engine, documentation, etc.).
* The guidelines for contributing to any project.
* Organizational structures (tools and teams) of Godot contributors.
The following kinds of information **should not** be documented here:
* Information that is relevant to regular users of Godot (not just potential contributors).
* Please document this in `docs.godotengine.org <https://docs.godotengine.org>`__
* Information that changes across different versions of Godot.
* Please document this in `docs.godotengine.org <https://docs.godotengine.org>`__
* Technical information about any of Godot's repositories.
* Please document this in the respective repositories.
How is this page structured?
============================
This page is structured such that it is easy to find the different ways
in which you can contribute to Godot. To accomplish this, every *kind*
of contribution should have a dedicated section in the side bar. If a new
way to contribute emerges, it should get a dedicated section in the side
bar so that it is easy to find.

1
index.rst
View File

@@ -68,6 +68,7 @@ for your topic of interest. You can also use the search function in the top-left
documentation/class_reference
documentation/manual/index
documentation/translation/index
documentation/contributing_to_the_contributing_docs
.. toctree::
:hidden:

2
other/ideas.rst
View File

@@ -1,3 +1,5 @@
.. _doc_contributing_ideas:
Contributing ideas and change proposals
=======================================