Git-Mirrors/constellation

mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00

Moritz Eckert b95f3dbc91

Add docs to repo (#38 )

2022-09-02 11:52:42 +02:00

926 B

Raw Blame History

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

Release process

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.