From 282be6f26dd4dfb57c3a21b92b756c40c05b2e6c Mon Sep 17 00:00:00 2001 From: decentral1se <1991377+decentral1se@users.noreply.github.com> Date: Tue, 23 May 2023 17:38:39 +0200 Subject: [PATCH] [docs] local docs hacking howto (#1816) Co-authored-by: decentral1se --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c24e81221..a706119e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,17 @@ The process for documentation pull requests is a bit looser than the process for If you see something in the documentation that's missing, wrong, or unclear, feel free to open a pull request addressing it; you don't necessarily need to open an issue first, but please explain why you're opening the PR in the PR comment. +We support a [Conda](https://docs.conda.io/en/latest/)-based workflow for hacking, building & publishing the documentation. Here's how you can get started locally: + +* Install [`miniconda`](https://docs.conda.io/en/latest/miniconda.html) +* Create your conda environment: `conda env create -f ./docs/environment.yml` +* Activate the environment: `conda activate gotosocial-docs` +* Serve locally: `mkdocs serve` + +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. + ## Development ### Golang forking quirks