Skip to content

Commit

Permalink
Add explanation about versioned docs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Atul9 committed Sep 26, 2018
1 parent 054416b commit 0d51cfa
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad

Read our [contributing guide](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

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.

### Versioned docs

- `/docs` - the files in here are responsible for the "next" version at https://docusaurus.io/docs/en/next/installation.
- `v1/website/versioned_docs/version-1.4.0` - these are the docs for the currently published version at https://docusaurus.io/docs/en/installation.

To make a fix to the published site you must edit the corresponding markdown file at both folders.

### Beginner Friendly Bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/Docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started.
Expand Down

0 comments on commit 0d51cfa

Please sign in to comment.