Merge pull request #141 from alan-turing-institute/joss-docs

Joss docs
alan-turing-institute · Oct 17, 2024 · 877e8a3 · 877e8a3
2 parents 7dc0cc7 + 2ac584a
commit 877e8a3
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -0,0 +1,14 @@
+.. _contribute:
+
+Contribute
+==========
+
+We welcome contributions to setvis! Please use the github issue tracker to report bugs or request features. If you would like to contribute code, please fork the repository and submit a pull request.
+
+We do not have a set of standard workflow to develop setvis so you are welcome to use your own workflow.
+
+You do not need to be a developer to contribute to setvis. We welcome contributions of documentation, bug reports, and feature requests.
+
+To use GitHub to contribute, and you could contribute outside of GitHub, and if you do not have any experience with GitHub, you can learn how to use it by following the `GitHub Getting Started Guide <https://docs.github.com/en/get-started/getting-started-with-git>`_.
+
+If you are looking to find the documentation to generate the documentation of setvis locally, see :ref:`setvis documentation <setvis-documentation>`.
diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst
@@ -1,7 +1,9 @@
-Contributors
-============
+.. _setvis-documentation:
 
-This section contains information useful for anyone planning to contribute to setvis.
+setvis documentation
+====================
+
+This section contains information useful for anyone planning to generate the documentation of setvis locally.
 
 Generating documentation locally
 --------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -33,9 +33,10 @@ Contents
    :maxdepth: 2
 
    installation
+   api_reference
    tutorials
    documentation
-   api_reference
+   contributing
 
 Introductory Example
 ====================