chore: Document Material for MkDocs Insiders limitations in CONTRIBUTING.md in more detail #19373
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ING.md in more detail
ntBre
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
It took me some time to figure out that as an outside contributor I can't reproduce the docs. This is because the Ruff docs use Material for MkDocs Insiders, which is closed source.
While CONTRIBUTING.md has terse comments to point outside contributors to a fallback, it does not go into much detail.
This PR adds a Note admonition to highlight to new contributors that they can't fully reproduce the docs locally, with a relevant link to the features that are missing from the OSS version.
I arrived here through a rabbit hole via #19362 and #19369