Beta version of the Voxel51 Technical Documentation

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 doc:

1. Make and activate a virtual environment
2. Be in the root directory of the repo
3. pip install -r requirements.txt
4. Run mkdocs serve
5. PARTY!

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:

1. Find an existing Github issue and start discussing what you would like to do
2. Create a new Github issue so we can discuss it with you
3. 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