3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 23:57:22 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): fix doc changes in #2606

Browse source
This commit is contained in:
Yangshun Tay 2020-04-15 02:38:55 +08:00
parent a7b802f31a
commit 2f2e3cd99d
2 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
website/docs/versioning.md
View file

@ -5,9 +5,13 @@ title: Versioning
You can use the version script to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory changes moving forward.
:::caution Think about it before starting to version your documentation - it can become difficult for contributors to help improve it! :::
:::caution
Most of the time, you don't need versioning as it will just increase your build time, and introduce complexity to your codebase. Versioning is **best suited for website with high-traffic and rapid changes to documentation between versions**. If your documentation rarely changes, don't add versioning to your documentation.
Think about it before starting to version your documentation - it can become difficult for contributors to help improve it!
:::
Most of the time, you don't need versioning as it will just increase your build time, and introduce complexity to your codebase. Versioning is **best suited for websites with high-traffic and rapid changes to documentation between versions**. If your documentation rarely changes, don't add versioning to your documentation.
To better understand how versioning works and see if it suits your needs, you can read on below.