Thomas Tendyck 1a4c1f34bc
docs: refer to known issues (#1414)
* docs: refer to known issues

* publish
2023-03-14 08:27:06 +01:00
..
2023-03-14 08:27:06 +01:00
2023-03-11 00:13:32 +01:00
2022-09-02 11:52:42 +02:00
2022-09-02 11:52:42 +02:00
2023-03-06 10:43:49 +01:00
2023-03-09 13:14:28 +01:00

Constellation Documentation

Published @ https://docs.edgeless.systems/constellation via netlify.

Previewing

During edits you can preview your changes using the docusaurus:

# requires node >=16.14
npm install
npm run build
npm run serve

Browse to http://localhost:3000/constellation and choose the "Next" version in the top right.

Release process

  1. Tagging a new version

    npm run docusaurus docs:version X.X
    

    When tagging a new version, the document versioning mechanism will:

    Copy the full docs/ folder contents into a new versioned_docs/version-[versionName]/ folder. Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-[versionName]-sidebars.json. Append the new version number to versions.json.