docs/README.md

# 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
publish new docs (#32922) * push new docs * drop the new, just docs * cleanup 2024-07-07 19:13:48 -07:00			`# openpilot docs`
Docs: fix old docs still being populated (#30825) * fix push * also remove cached files * fix readme * add readme * remove that wip submodule 2023-12-20 13:56:34 -08:00
publish new docs (#32922) * push new docs * drop the new, just docs * cleanup 2024-07-07 19:13:48 -07:00			`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`