Skip to content

Commit d8f2651

Browse files
nleveeclaude
andcommitted
docs(contributing): include mise in the docs-build instructions
Add the `mise run mkdocs-serve` path alongside the raw Python/pip flow. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 993a62f commit d8f2651

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/contributing.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,15 @@ It is strongly recommended to create a GitHub token with no specific rights to b
212212

213213
### Building the Documentation Locally
214214

215-
The documentation site is built with [MkDocs](https://www.mkdocs.org/). To preview your changes, you need Python 3:
215+
The documentation site is built with [MkDocs](https://www.mkdocs.org/).
216+
217+
If you use [mise](#using-mise-recommended), the toolchain (`uv`) is already available and a task is provided:
218+
219+
```bash
220+
mise run mkdocs-serve # installs deps into .venv, then serves at http://127.0.0.1:8000
221+
```
222+
223+
Otherwise, with Python 3 directly:
216224

217225
```bash
218226
pip install -r requirements.txt # mkdocs + material theme + plugins

0 commit comments

Comments
 (0)