summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Daenney <daenney@users.noreply.github.com>2023-07-08 15:44:58 +0200
committerLibravatar GitHub <noreply@github.com>2023-07-08 15:44:58 +0200
commit747ea584bd13f36157a1ba504edf3d65a7a4face (patch)
tree3dcefa6e04932816244ece6723911d05f0de8a8c
parent[bugfix] Don't overflow on very wide status'es (#1956) (diff)
downloadgotosocial-747ea584bd13f36157a1ba504edf3d65a7a4face.tar.xz
[docs] Clarify how to add a page (#1959)
* Add instructions on how to make a new page show up in the sidebar / navigation * Explain how to create a virtual env to install the dependencies in if you're not using Conda
-rw-r--r--CONTRIBUTING.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a3d705af6..853bf6145 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -106,7 +106,9 @@ We support a [Conda](https://docs.conda.io/en/latest/)-based workflow for hackin
Then you can visit [localhost:8000](http://127.0.0.1:8000/) in your browser to view.
-If you don't use Conda, you can read the `docs/environment.yml` to see which dependencies are required and `pip install` them manually.
+When adding a new page, you need to include it in the [`mkdocs.yml`](mkdocs.yml) so it shows in the sidebar in the right section.
+
+If you don't use Conda, you can read the `docs/environment.yml` to see which dependencies are required and `pip install` them manually. It's advisable to do this in a virtual environment, which you can create with something like `python3 -m venv /path-to/store-the-venv`. You can then call `/path-to/store-the-venv/bin/pip`, `/path-to/store-the-venv/bin/mkdocs` etc.
## Development