openpilot0/docs
Adeeb Shihadeh 97c990dac6
docs: init glossary (#33995)
2024-11-11 16:21:50 -08:00
..
assets Revert "docs: fix car docs video icon" (#31234) 2024-01-30 19:04:43 -08:00
car-porting docs: car port info cleanup (#33630) 2024-09-23 16:39:36 -04:00
concepts docs: init glossary (#33995) 2024-11-11 16:21:50 -08:00
contributing docs: add #current-projects link 2024-08-06 16:43:57 -07:00
getting-started docs: fix nested structure (#33114) 2024-07-28 15:38:38 -07:00
how-to docs: add user and pass to C3X serial console instructions (#33921) 2024-11-02 13:18:20 -07:00
CARS.md Ford Q3: enable long by default (#33945) 2024-11-06 16:21:44 -08:00
CONTRIBUTING.md update bounties link in `CONTRIBUTING.md` (#33631) 2024-09-23 15:32:08 -07:00
INTEGRATION.md
LIMITATIONS.md
README.md docs: fix README.md (#33142) 2024-07-30 13:57:42 -07:00
SAFETY.md Update SAFETY.md (#29129) 2023-07-24 21:13:40 -07:00
WORKFLOW.md remove pre-commit (explorations) (#33172) 2024-08-01 22:16:13 -07:00
index.md docs: fix nested structure (#33114) 2024-07-28 15:38:38 -07:00

README.md

openpilot docs

This is the source for docs.comma.ai. The site is updated on pushes to master by this workflow.

Development

NOTE: Those commands must be run in the root directory of openpilot, not /docs

1. Install the docs dependencies

pip install .[docs]

2. Build the new site

mkdocs build

3. Run the new site locally

mkdocs serve

References: