Add CONTRIBUTING.md and improve guidance (plus other changes) #47
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
✅ Deploy Preview for discordtickets ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
eartharoid
reviewed
Mar 5, 2025
|
|
||
| If you choose to run a local preview, the site will not look the same as the production version, this is because it is built with a specific version of the Insiders edition of the theme, which has additional features and a different config. | ||
|
|
||
| This is normal as the v4 documentation uses a newer version of MkDocs that is configured differently. |
There was a problem hiding this comment.
This line isn't necessary with the line above.
There was a problem hiding this comment.
I copied it as it was originally and just put that on a new line, I'll fix this too
|
|
||
| If you want to preview locally, clone the repo and then run `pip install -r requirements.txt` and `mkdocs serve`. | ||
|
|
||
| If you choose to run a local preview, the site will not look the same as the production version, this is because it is built with a specific version of the Insiders edition of the theme, which has additional features and a different config. |
There was a problem hiding this comment.
because it is built
This is slightly confusing, I thought "it" referred to the local preview at first.
There was a problem hiding this comment.
Oops I forgot about this, will fix this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This adds a new CONTRIBUTING.md guide with a link to it that has improved guidance on how to contribute to the documentation and things to watch out for. It also does some more general housekeeping like removing the dead link to the v3 docs.
I might change the TIP and CAUTION labels used in the guidance but I want to gauge feedback first