publish new docs (#32922)

* push new docs

* drop the new, just docs

* cleanup
old-commit-hash: 241fb902af49ca43bf343c60f7f96b85128a9db9
This commit is contained in:
Adeeb Shihadeh
2024-07-07 19:13:48 -07:00
committed by GitHub
parent a250b02f32
commit 2b873af75e
12 changed files with 308 additions and 132 deletions

1
docs/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
/site/

View File

@@ -1,3 +1,22 @@
# openpilot-docs
# openpilot docs
These docs are autogenerated from [this folder](https://github.com/commaai/openpilot/tree/master/docs) in the main openpilot repository.
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

View File

@@ -1,12 +0,0 @@
This is the source for a new https://docs.comma.ai. It's not hosted anywhere yet, but it's easy to run locally.
https://www.mkdocs.org/getting-started/
```
pip install mkdocs mkdocs-terminal
mkdocs serve
```
inspiration:
* https://rerun.io/docs/
* https://docs.expo.dev/