Added new README.md for new Docusaurus projects #930
Conversation
|
Deploy preview for docusaurus-preview ready! Built with commit c78ae64 |
There was a problem hiding this comment.
I personally think that it is too long and can be intimidating. For more details they should open Docusaurus website directly. I think a very basic quick start is sufficient. The goal is so that the contributor to new Docusaurus project can quickly get started.
What do you think ?
Example:
🚀 Introduction
This website was created with Docusaurus.
📟 Install and Usage
First of all, you will need to install all the dependencies for the website
$ yarnNow just run your dev server
$ yarn startThat's it! Now you can make changes to the docs folder of the project directory.
Check docusaurus.io to see more about Docusaurus!
@JoelMarcey @yangshun any opinions ?
|
Understood - I erred on having too much than too little (checked out #246 requirements), since it's easy to trim afterwards. Makes sense that the goal should be to have contributors get started without being intimidated, and directly point them towards the website for additional details. Bonus points for keeping the documentation references in one place, rather than having to update this README.md anytime there are changes. Will wait for feedback from @JoelMarcey and @yangshun. |
|
@notjaril Thanks for doing this! 👍 I agree that we should have a simple readme and point people to existing links. |
yangshun
changed the title
|
This looks awesome @notjaril! Let's merge this. |
|
CI tests are failing but it seems like a flaky issue and we can merge this. |
Motivation
Fixes #925
First pass at a basic README.md for new websites.
I checked the PRs for documentation websites built with Docusaurus, and it seemed that most PRs were related to adding/editing content, and less about configuring layouts/siteConfig. That's why I added instructions for the popular use cases in the README.md, each with a link to the relevant part of the docs website for further reading.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Check that running docusaurus-init copies the new README.md to the website folder
Related PRs
N/A