How to Version Docs

Workflow for a New Version

• 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 in https://comit.network/docs/next/.
• When you want to publish your changes for real to https://comit.network/docs/, run yarn docusaurus docs:version <your version e.g. 0.15.3>.
• The above command will create a version-0.15.3 folder in versioned_docs and version-0.15.3-sidebars.json in versioned_sidebars. Think of these files as versioned snapshots of the documentation.
• That's it. You can commit and push.
• The website is automatically redeployed whenever master is updated.

Workflow for an Existing Version

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 in versions.json. Then, run yarn docusaurus docs:version 0.15.2.