From 126c909851ceb9bf1981a41064d3f6089878c94c Mon Sep 17 00:00:00 2001 From: Mathis Gauthey <46576952+mathisgauthey@users.noreply.github.com> Date: Fri, 24 Jan 2025 08:51:37 +0100 Subject: [PATCH] docs(local-dev): add `pdm install` step Based on a discussion in #33729, it was missing from the local dev doc. --- docs/development/local-development.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/development/local-development.md b/docs/development/local-development.md index 1dbc13ff1dd500..43e0b0ae7f513d 100644 --- a/docs/development/local-development.md +++ b/docs/development/local-development.md @@ -177,6 +177,7 @@ If you're only working on the documentation files, you can use the `pnpm doc-fix ## Documentation We use [MkDocs](https://www.mkdocs.org) to generate the documentation. +To install the required dependency, use `pdm install`. You can run `pnpm build:docs` to generate the docs. Then use `pnpm mkdocs serve` to preview the documentation locally. The docs will update automatically when you run `pnpm build:docs` again, no need to stop the `pnpm mkdocs serve` command.