docs: Add explanation about versioned docs to readme #986
Conversation
|
Deploy preview for docusaurus-preview ready! Built with commit f9812c5 |
endiliey
changed the title
There was a problem hiding this comment.
I agree - CONTRIBUTING.md is a better place to this. You can add a link to the CONTRIBUTING.md somewhere in the ## Contributing section of the README.md though. Maybe add a sentence to the end of that section that says "Please see our contributing guidelines for information on how to contribute to Docusaurus" with a link to CONTRIBUTING.md at "contributing guidelines"
Atul9
force-pushed
the
readme-version-docs
branch
from
0d51cfa to
4b2b00b
Compare
Atul9
force-pushed
the
readme-version-docs
branch
from
4b2b00b to
13a2c09
Compare
|
@JoelMarcey @yangshun I have moved the versioned docs section to contributing.md file & updated the PR. @JoelMarcey We have "Contributing"(https://github.com/facebook/Docusaurus#contributing) & "Contributing guide"(https://github.com/facebook/Docusaurus#contributing-guide) section. |
CONTRIBUTING.md
Outdated
| @@ -18,6 +18,15 @@ There are many ways to contribute to Docusaurus, and many of them do not involve | |||
|
|
|||
| Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help. | |||
|
|
|||
| You might want to make yourself familiar with [docusaurus](https://docusaurus.io/docs/en/installation) to make significant changes to the website. If you only want to make content changes you just need to know about versioned docs. | |||
There was a problem hiding this comment.
This is not relevant because for our entire project (website + library), the users have to be familiar with Docusaurus. I'll change this.
closes #983
Motivation
Add explanation about versioned docs to readme
(Write your motivation here.)
Have you read the Contributing Guidelines on pull requests?
Yes
(Write your answer here.)
Test Plan
View README file on Github in markdown format
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Related PRs
None
(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.)