-
Notifications
You must be signed in to change notification settings - Fork 5
How to Version Docs
Yos Riady edited this page Apr 28, 2020
·
16 revisions
- You only modify files in
docs/
- If you don't want to publish the changes yet, you can commit and push at this point. Your changes won't be viewable in
https://comit.network/docs/
, but it will be inhttps://comit.network/docs/next/
. - When you want to publish your changes for real to
https://comit.network/docs/
, runyarn docusaurus docs:version <your version e.g. 0.15.3>
. - The above command will create a
version-0.15.3
folder inversioned_docs
andversion-0.15.3-sidebars.json
inversioned_sidebars
. Think of these files as versioned snapshots of the documentation. - That's it. You can commit and push.
Note: You can republish the documentation for an old version by first removing the version string (e.g. e.g.
0.15.2
) you want to overwrite inversions.json
. Then, runyarn docusaurus docs:version 0.15.2
.