misc: add note about edits in versioned docs #2368
Merged
Conversation
This file contains 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 docusaurus-2 ready! Built with commit 2019473 |
yangshun
approved these changes
Mar 7, 2020
There was a problem hiding this comment.
This would be helpful and I hope more users read the CONTRIBUTING.md. I feel that many of them don't read :/
Another idea I had was to inject an admonition in __DEV__ only and warn them in the UI of the current version of the docs, that would be hard to miss.
|
This is actually a good task for @docusaurus-bot! |
yangshun
added
the
pr: maintenance
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
We often encounter some misunderstanding of versioned docs by contributors - they document new changes in versioned docs and/or fix typos only in versioned docs. It seems to me that I need to somehow clarify this.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
GitHub.
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)