mawei
/
openpilot0
mirror of https://github.com/commaai/openpilot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
openpilot0/mkdocs.yml

39 lines
1.2 KiB
YAML
Raw Normal View History

setup new docs.comma.ai (#32813) * start with mkdocs * some structure * little more old-commit-hash: 0c3f1dc016513037643a4ba2765233bb72b83fce
2024-06-24 04:16:39 +08:00
site_name: openpilot docs
repo_url: https://github.com/commaai/openpilot/
mvp of new docs.comma.ai (#32926) * ssh docs * strict * need an index * push to prod old-commit-hash: f6189568eab0244ed792ef299fb781cc4c92fb9b
2024-07-09 07:55:16 +08:00
site_url: https://docs.comma.ai
docs: fix README.md (#33142) * md * Update README.md * rename * exclude * Update README.md old-commit-hash: 086dcfe715985447fa33f120d16a496309718ba2
2024-07-31 04:57:42 +08:00
exclude_docs: README.md
mvp of new docs.comma.ai (#32926) * ssh docs * strict * need an index * push to prod old-commit-hash: f6189568eab0244ed792ef299fb781cc4c92fb9b
2024-07-09 07:55:16 +08:00
strict: true
docs: fix nested structure (#33114) * docs: fix nested structure * test ci * that too * update that * not common mark anymore old-commit-hash: 4fbac089f81079595df9852eace44cea9de3dd03
2024-07-29 06:38:38 +08:00
docs_dir: docs
site_dir: docs_site/
setup new docs.comma.ai (#32813) * start with mkdocs * some structure * little more old-commit-hash: 0c3f1dc016513037643a4ba2765233bb72b83fce
2024-06-24 04:16:39 +08:00
theme:
docs: readthedocs theme (#33116) * docs: read the docs theme * nav depth old-commit-hash: 691b948ad02a20e507d5059707f8cde51a94a703
2024-07-29 07:07:39 +08:00
name: readthedocs
navigation_depth: 3
setup new docs.comma.ai (#32813) * start with mkdocs * some structure * little more old-commit-hash: 0c3f1dc016513037643a4ba2765233bb72b83fce
2024-06-24 04:16:39 +08:00
nav:
- Getting Started:
- What is openpilot?: getting-started/what-is-openpilot.md
- How-to:
docs: turning the speed blue (#33079) * blue speed * compile * just blue * cleanup old-commit-hash: db2a8e9506bf4b76f34240b79bc5643f1db3e0b1
2024-07-27 06:58:00 +08:00
- Turn the speed blue: how-to/turn-the-speed-blue.md
mvp of new docs.comma.ai (#32926) * ssh docs * strict * need an index * push to prod old-commit-hash: f6189568eab0244ed792ef299fb781cc4c92fb9b
2024-07-09 07:55:16 +08:00
- Connect to a comma 3/3X: how-to/connect-to-comma.md
docs: add concepts section old-commit-hash: 5ebc65f254f66ff13c679f9f699a92458c41aa8a
2024-07-29 07:38:38 +08:00
#- Replay a drive: how-to/replay-a-drive.md
- Concepts:
- Logs: concepts/logs.md
- Safety: concepts/safety.md
setup new docs.comma.ai (#32813) * start with mkdocs * some structure * little more old-commit-hash: 0c3f1dc016513037643a4ba2765233bb72b83fce
2024-06-24 04:16:39 +08:00
- Car Porting:
- What is a car port?: car-porting/what-is-a-car-port.md
- Porting a car brand: car-porting/brand-port.md
- Porting a car model: car-porting/model-port.md
mvp of new docs.comma.ai (#32926) * ssh docs * strict * need an index * push to prod old-commit-hash: f6189568eab0244ed792ef299fb781cc4c92fb9b
2024-07-09 07:55:16 +08:00
- Contributing:
- Roadmap: contributing/roadmap.md
#- Architecture: contributing/architecture.md
docs: readthedocs theme (#33116) * docs: read the docs theme * nav depth old-commit-hash: 691b948ad02a20e507d5059707f8cde51a94a703
2024-07-29 07:07:39 +08:00
- Contributing Guide →: https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md
mvp of new docs.comma.ai (#32926) * ssh docs * strict * need an index * push to prod old-commit-hash: f6189568eab0244ed792ef299fb781cc4c92fb9b
2024-07-09 07:55:16 +08:00
- Links:
docs: style for external links old-commit-hash: c8d5a3fe25dfda776adc3daa7020c20f03e8bf5e
2024-07-27 07:25:07 +08:00
- Blog →: https://blog.comma.ai
- Bounties →: https://comma.ai/bounties
- GitHub →: https://github.com/commaai
- Discord →: https://discord.comma.ai
- X →: https://x.com/comma_ai