consolidate contributing

sciris · Nov 1, 2023 · 3deee49 · 3deee49
1 parent bd2f6c4
commit 3deee49
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 13 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -4,10 +4,10 @@ Contributing
 
 Welcome! We are thrilled you are interested in contributing to Sciris. (No, seriously.) This document will help you get started.
 
-- We are serious about inclusion and believe the open-source software community still has a long way to go. The Sciris community follows a `code of conduct`_. By participating in this project, you agree to abide by its terms.
-- Take a look at our house `style guide`_. Sciris more or less follows Google's Python style guide, but with some exceptions. 
+- We are serious about inclusion and believe the open-source software community still has a long way to go. The Sciris community follows a code of conduct. By participating in this project, you agree to abide by its terms.
+- Take a look at our house style guide. Sciris more or less follows Google's Python style guide, but with some exceptions. 
 - Feel free to `open an issue`_ on more or less anything! This project is small enough that we don't need a formal triage system.
-- Pull requests should be made against ``develop``. In addition to following the `style guide`_, please make sure the tests pass (``run_tests`` in the ``tests`` folder; they also run via GitHub actions).
+- Pull requests should be made against ``develop``. In addition to following the style guide, please make sure the tests pass (``run_tests`` in the ``tests`` folder; they also run via GitHub actions).
 
 If you have any other questions, please reach out to us: info@sciris.org. Thank you!
 

diff --git a/STYLE_GUIDE.rst b/STYLE_GUIDE.rst
@@ -2,7 +2,7 @@
 Style guide 
 ===========
 
-In general, Sciris follows Google's `style guide <https://google.github.io/styleguide/pyguide.html>`_. If you simply follow that, you can't go too wrong. However, there are a few "house style" differences, which are described here.
+In general, Sciris follows Google's `style guide <https://google.github.io/styleguide/pyguide.html>`__. If you simply follow that, you can't go too wrong. However, there are a few "house style" differences, which are described here.
 
 
 Design philosophy

diff --git a/docs/code_of_conduct.rst b/docs/code_of_conduct.rst
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1 +1,3 @@
-.. include:: ../CONTRIBUTING.rst
+.. include:: ../CONTRIBUTING.rst
+.. include:: ../CODE_OF_CONDUCT.rst
+.. include:: ../STYLE_GUIDE.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,7 +18,7 @@ Learn more
 .. grid:: 2
     :gutter: 4
 
-    .. grid-item-card:: Getting started
+    .. grid-item-card:: Overview
         :link: overview
         :link-type: doc
 
@@ -51,7 +51,5 @@ Learn more
    tutorials/index
    whatsnew
    contributing
-   code_of_conduct
-   style_guide
    api/index
 
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -1,5 +1,5 @@
-Getting started
-===============
+Overview
+========
 
 .. currentmodule:: sciris
 
@@ -129,7 +129,7 @@ Citation
 
 To cite Sciris, cite the `paper <http://paper.sciris.org>`_:
 
-  Kerr CC, Sanz-Leon P, Abeysuriya RG, Chadderdon GL, Harbuz VS, Saidi P, Quiroga M, Martin-Hughes R, Kelly SL, Cohen JA, Stuart RM, Nachesa AN. **Sciris: Simplifying scientific software in Python**. *Journal of Open Source Software* 2023 **8**(88):5076. DOI: https://doi.org/10.21105/joss.05076
+  Kerr CC, Sanz-Leon P, Abeysuriya RG, Chadderdon GL, Harbuz VS, Saidi P, Quiroga M, Martin-Hughes R, Kelly SL, Cohen JA, Stuart RM, Nachesa AN. **Sciris: Simplifying scientific software in Python.** *Journal of Open Source Software* 2023 **8** (88):5076. DOI: https://doi.org/10.21105/joss.05076
 
 The citation is also available in `BibTeX format`_.
 

diff --git a/docs/style_guide.rst b/docs/style_guide.rst