From 67b942000330e7f2c1598db8b3b815e4076ced48 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Thu, 4 May 2023 01:32:19 -0400 Subject: [PATCH 1/2] Add contributing guide index page & link it in toctree --- doc/contributing_guide/index.rst | 8 ++++++++ doc/index.rst | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 doc/contributing_guide/index.rst diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst new file mode 100644 index 000000000..7d6073c67 --- /dev/null +++ b/doc/contributing_guide/index.rst @@ -0,0 +1,8 @@ +.. _cg_index: + +Arcade Contributing Guide +========================= + +This section is for people who want to make contributions or propose +changes to Arcade itself. For a quick overview, please see +`CONTRIBUTING.md `_. diff --git a/doc/index.rst b/doc/index.rst index 83941285a..dd57d9f1b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -113,8 +113,9 @@ The Python Arcade Library .. toctree:: :maxdepth: 1 - :caption: Source Code + :caption: Source Code & Contributing + contributing_guide/index GitHub programming_guide/release_notes License From 4134c8df57e55e88ce0f452abde2c688e7f16841 Mon Sep 17 00:00:00 2001 From: pushfoo <36696816+pushfoo@users.noreply.github.com> Date: Mon, 15 May 2023 10:34:13 -0400 Subject: [PATCH 2/2] Flesh out the Contributing Guide index page --- doc/contributing_guide/index.rst | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/doc/contributing_guide/index.rst b/doc/contributing_guide/index.rst index 7d6073c67..e1463ae9a 100644 --- a/doc/contributing_guide/index.rst +++ b/doc/contributing_guide/index.rst @@ -3,6 +3,29 @@ Arcade Contributing Guide ========================= -This section is for people who want to make contributions or propose -changes to Arcade itself. For a quick overview, please see -`CONTRIBUTING.md `_. +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