Contrast Documentation

Previewing changes locally

The Contrast flake contains a development shell for working on the documentation.

It's automatically activated when you are using direnv. Otherwise enter the environment with:

nix develop .#docs

Run a local development server previewing your changes with:

yarn start

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

CI integration

• PR preview Created by docs_publish on PR. This will build the website and push it to the /pr-preview directoryof the gh-pages branch.
• Publishing Deployed by docs_publish on push to main. This will build the website and push it to the gh-pages branch.
• Actual deployment happens through a GitHub controlled action.
• Release versioning happens as part of the release workflow

Check out the latest deployments (both main and PR preview).

Attestation graphics

Here is how you can modify and rebuild the attestation graphics.

Requirements:

• Inkscape
• goat

1. Edit the ASCII art
2. Render the SVG with goat: `goat -i .txt -o .svg
3. Export text to path with inkscape: inkscape <graphic>.svg -o --export-plain-svg=attestation-pod.svg --export-text-to-path