contributing guidelines in docs

Author: aryamanarora

CONTRIBUTING.md

@@ -11,7 +11,7 @@ For Priority Tag, you can use `[P0]`-`[P2]`, `[P0]` is the highest priority, whi
 
 ---
 
-### :book: Pull Requests
+### 📕 Pull Requests
 
 #### Uninstall pyvene from python library
 It becomes tricky if you have `pyvene` installed while debugging with this codebase, since imports can be easily messed up. Please run,
@@ -45,7 +45,7 @@ When checking in new code, please also consider to add new tests in the same PR.
 
 ```
 
-### :beetle: Bug Reports and Other Issues
+### 🪲 Bug Reports and Other Issues
 Go to issues, and open with a title formatted as,
 ```
 [Bug Fix] Short Title
@@ -55,5 +55,19 @@ For external requests (i.e., you are not in our core dev team), please use,
 [External] Short Title
 ```
 
-### :inbox_tray: Larger Feature Requests
-Please email us!
+### 📄 Documentation
+If making changes to documentation (in `docs/source`, deployed to GitHub Pages), please test your changes locally
+(ideally in a fresh Python environment):
+
+```
+pip install -r requirements.txt
+pip install -r docs/requirements.txt
+cd docs
+make html
+python -m http.server
+```
+
+Then navigate to [localhost:8000/build/html](http://localhost:8000/build/html).
+
+### 📥 Larger Feature Requests
+Please email us!

docs/source/conf.py

@@ -13,7 +13,7 @@
 project = 'pyvene'
 copyright = '2024, Stanford NLP'
 author = 'Stanford NLP'
-release = '0.1'
+release = '0.1.2'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -71,6 +71,12 @@
         'target': 'tutorials/pyvene_101.ipynb',
         'ignore': [],
     },
+    'contributing': {
+        'driver': 'copy_file',
+        'source': os.path.abspath('../../CONTRIBUTING.md'),
+        'target': 'guides/contributing.md',
+        'ignore': [],
+    },
 }
 
 # -- Options for HTML output -------------------------------------------------

docs/source/index.rst

@@ -461,14 +461,9 @@ Star History
 
 .. toctree::
    :hidden:
-   :caption: API
-
-   api/core
-
-.. toctree::
-   :hidden:
-   :caption: Extensions
+   :caption: Guides
 
+   guides/contributing
    guides/ndif
 
 
@@ -498,6 +493,12 @@ Star History
    tutorials/advanced_tutorials/MQNLI
    tutorials/advanced_tutorials/Voting_Mechanism
 
+.. toctree::
+   :hidden:
+   :caption: API
+
+   api/core
+
 
 Indices and tables
 ==================