openpilot_comma/docs/README

# openpilot docs

This is the source for [docs.comma.ai](https://docs.comma.ai).
The site is updated on pushes to master by this [workflow](../.github/workflows/docs.yaml).

## development
```
# install the docs dependencies
pip install .[docs]

cd docs/

# for a development server
mkdocs serve

# build the site
mkdocs build
```

References:
* https://www.mkdocs.org/getting-started/
* https://github.com/ntno/mkdocs-terminal