Skip to content

Commit b03f4f9

Browse files
docs: fix README.md (#33142)
* md * Update README.md * rename * exclude * Update README.md old-commit-hash: 086dcfe
1 parent 6c1d735 commit b03f4f9

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

docs/README renamed to docs/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@
33
This is the source for [docs.comma.ai](https://docs.comma.ai).
44
The site is updated on pushes to master by this [workflow](../.github/workflows/docs.yaml).
55

6-
## development
7-
```
8-
# install the docs dependencies
6+
## Development
7+
NOTE: Those commands must be run in the root directory of openpilot, **not /docs**
8+
9+
**1. Install the docs dependencies**
10+
``` bash
911
pip install .[docs]
12+
```
1013

11-
cd docs/
14+
**2. Build the new site**
15+
``` bash
16+
mkdocs build
17+
```
1218

13-
# for a development server
19+
**3. Run the new site locally**
20+
``` bash
1421
mkdocs serve
15-
16-
# build the site
17-
mkdocs build
1822
```
1923

2024
References:

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ site_name: openpilot docs
22
repo_url: https://github.com/commaai/openpilot/
33
site_url: https://docs.comma.ai
44

5+
exclude_docs: README.md
6+
57
strict: true
68
docs_dir: docs
79
site_dir: docs_site/

0 commit comments

Comments
 (0)