dragonpilot beta3

date: 2024-07-13T18:45:35
commit: c25d768a9e

docs/README.md

@@ -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