diff --git a/doc/programming_guide/directory_structure.rst b/doc/contributing_guide/directory_structure.rst similarity index 100% rename from doc/programming_guide/directory_structure.rst rename to doc/contributing_guide/directory_structure.rst diff --git a/doc/programming_guide/how_to_build.rst b/doc/contributing_guide/how_to_build.rst similarity index 100% rename from doc/programming_guide/how_to_build.rst rename to doc/contributing_guide/how_to_build.rst diff --git a/doc/programming_guide/how_to_contribute.rst b/doc/contributing_guide/how_to_contribute.rst similarity index 100% rename from doc/programming_guide/how_to_contribute.rst rename to doc/contributing_guide/how_to_contribute.rst diff --git a/doc/programming_guide/how_to_submit_changes.rst b/doc/contributing_guide/how_to_submit_changes.rst similarity index 100% rename from doc/programming_guide/how_to_submit_changes.rst rename to doc/contributing_guide/how_to_submit_changes.rst diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst new file mode 100644 index 000000000..798509a74 --- /dev/null +++ b/doc/contributing_guide/index.rst @@ -0,0 +1,37 @@ +.. _cg_index: + +Arcade Contributing Guide +========================= + +The contributing guide is for people who want to propose changes, +implement features, or report bugs in Arcade itself. + +For information on how to use arcade to build your own projects, please see +:ref:`pg_index`. + + +.. _cg_index_quickstart: + +Contributing Quickstart +^^^^^^^^^^^^^^^^^^^^^^^ +For a quick overview, please see +`CONTRIBUTING.md on GitHub `_. + + +.. _cg_index_contents: + +Contributing Guide Contents +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The sections linked below will provide more in-depth coverage of various topics +contributing to arcade, including links to outside resources on development tools +and practices. + +.. toctree:: + :maxdepth: 1 + + directory_structure + how_to_contribute + how_to_build + how_to_submit_changes + release_checklist diff --git a/doc/programming_guide/release_checklist.rst b/doc/contributing_guide/release_checklist.rst similarity index 100% rename from doc/programming_guide/release_checklist.rst rename to doc/contributing_guide/release_checklist.rst diff --git a/doc/index.rst b/doc/index.rst index 83941285a..beaad665f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -77,13 +77,8 @@ The Python Arcade Library programming_guide/get_started programming_guide/sprites/index programming_guide/how_to_get_help - programming_guide/directory_structure programming_guide/edge_artifacts/index - programming_guide/how_to_submit_changes - programming_guide/how_to_contribute - programming_guide/how_to_build programming_guide/logging - programming_guide/release_checklist programming_guide/pygame_comparison programming_guide/headless programming_guide/vsync @@ -113,11 +108,17 @@ The Python Arcade Library .. toctree:: :maxdepth: 1 - :caption: Source Code + :caption: Source Code & Contributing GitHub programming_guide/release_notes License + contributing_guide/index + contributing_guide/directory_structure + contributing_guide/how_to_contribute + contributing_guide/how_to_build + contributing_guide/how_to_submit_changes + contributing_guide/release_checklist .. image:: images/social.svg :alt: Social icon diff --git a/doc/programming_guide/index.rst b/doc/programming_guide/index.rst index 694c9b727..0a6f04b6e 100644 --- a/doc/programming_guide/index.rst +++ b/doc/programming_guide/index.rst @@ -23,13 +23,8 @@ external documentation where applicable. get_started sprites/index how_to_get_help - directory_structure edge_artifacts/index - how_to_submit_changes - how_to_contribute - how_to_build logging - release_checklist pygame_comparison headless vsync