Skip to content

Commit b8dddd5

Browse files
chore: Document Material for MkDocs Insiders limitations in CONTRIBUTING.md in more detail (#19373)
Co-authored-by: Micha Reiser <micha@reiser.io>
1 parent e73a8ba commit b8dddd5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,13 @@ Finally, regenerate the documentation and generated code with `cargo dev generat
266266

267267
## MkDocs
268268

269+
> [!NOTE]
270+
>
271+
> The documentation uses Material for MkDocs Insiders, which is closed-source software.
272+
> This means only members of the Astral organization can preview the documentation exactly as it
273+
> will appear in production.
274+
> Outside contributors can still preview the documentation, but there will be some differences. Consult [the Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material/insiders/benefits/#features) for which features are exclusively available in the insiders version.
275+
269276
To preview any changes to the documentation locally:
270277

271278
1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install).

0 commit comments

Comments
 (0)