Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add explanation about versioned docs to readme #986

Merged
merged 2 commits into from
Sep 30, 2018
Merged

docs: Add explanation about versioned docs to readme #986

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13a2c09
Add explanation about versioned docs to readme
Atul9 Sep 26, 2018
f9812c5
Update CONTRIBUTING.md
yangshun Sep 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not relevant because for our entire project (website + library), the users have to be familiar with Docusaurus. I'll change this.


### 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.

### Join our Discord Channel

We have `#docusaurus-dev` on [Discord](https://discord.gg/docusaurus) to discuss all things Docusaurus development.
Expand Down