diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8de4e5d8c..b923eee1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,12 +98,15 @@ Two things to know before editing: **Code examples are not written into the pages.** They live in real tests under `docs/web-tests/{py,ts,rs}`, are extracted into `docs/web/snippets/`, and are -imported by the pages. Edit the test, then regenerate: +imported by the pages. Edit the test, then regenerate from the repository root: ```bash -uv run docs/web-tests/mdx_snippets_gen.py -s docs/web-tests/py +uv run docs/web-tests/mdx_snippets_gen.py -s docs/web-tests/py -s docs/web-tests/ts -s docs/web-tests/rs -o docs/web/snippets ``` +Review the diff before committing: a few modules currently regenerate with +unrelated changes, so commit only the snippets for the examples you changed. + An example that stops compiling fails the pull request that broke it. **Every heading carries an explicit `{#anchor}`.** Those anchors are how the