extern/gotosocial
1
1
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-07 17:04:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

[docs] local docs hacking howto (#1816)

Browse Source 
Co-authored-by: decentral1se <cellarspoon@riseup.net>
This commit is contained in:
decentral1se 2023-05-23 17:38:39 +02:00 committed by GitHub
parent d0e747cd58
commit 282be6f26d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -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. 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 ## Development
### Golang forking quirks ### Golang forking quirks