This is the source repository for the Voxel51 documentation site - https://beta-docs.voxel51.com
We love pull requests - everything from typos to full Jupyter Notebooks.
At its most simple, you can fork the repo in GitHub, make and commit your edits, and then open a PR. A step above would be setting up local development.
To install and edit the general docs doc:
- Make and activate a virtual environment, we recommend you to use Python 3.11 for this.
# Create a virtual environment named '.venv'
python3 -m venv .venv
# Activate the virtual environment
source .venv/bin/activate
# On linux/mac/Windows WSL
source .venv\bin\activate
# On windows in Powershell
source .venv\Scripts\activate`- Be in the root directory of the repo
pip install -r requirements.txt- Run
mkdocs serve --dirty. The --dirty flag specifies that if you edit a single file, mkdocs serve will only rebuild that one file rather than the entire documentation site. To do a clean build and force mkdocs to build everything runmkdocs server. Clean is the default behavior. - PARTY!
If you find errors while executing mkdocs serve related to the docs/api and docs/ts_api folders delete their symlinks and rerun the command.
To buid the entire doc site (only been test on Linux)
- Follow steps 1-3 above
./build.sh --venv <location of the venv you created in step 1 above>- Celebration!
To build the API docs along with the general docs you should use build.sh
Please be sure to read our CONTRIBUTING guide.
Before you take on a big editing tasks we highly recommend:
- Find an existing Github issue and start discussing what you would like to do
- Create a new Github issue so we can discuss it with you
- You can also come chat with us in Discord in the #docs channel - we are friendly and can give you good feedback.
Voxel51 Documentation by Voxel51 Inc is licensed under Creative Commons Attribution-ShareAlike 4.0 International
