openpilot0/docs
Alexandre Nobuharu Sato 94621d2fee Update what-is-a-car-port.md (#33323)
old-commit-hash: 7a40c97068
2024-08-19 14:28:13 -07:00
..
assets
car-porting Update what-is-a-car-port.md (#33323) 2024-08-19 14:28:13 -07:00
concepts docs: add concepts section 2024-07-28 16:38:41 -07: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: curl command updated (#33180) 2024-08-04 06:57:42 -07:00
CARS.md Honda: round minEnableSpeed correctly (#33250) 2024-08-09 23:42:40 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2024-08-09 11:02:18 -07:00
INTEGRATION.md
LIMITATIONS.md
README.md docs: fix README.md (#33142) 2024-07-30 13:57:42 -07:00
SAFETY.md
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: