Documentation

The Tenzir documentation resides at https://github.com/tenzir/docs. We use Astro with Starlight as website framework.

Build and view locally

Fetch external content, such as Markdown files from our .github repo:

make

Install the web framework dependencies:

pnpm install

Build a development version of the docs:

pnpm dev

Then browse to http://localhost:4321/ to view the site.

Build for production

We build a production build of the site in CI with every push to main. Check out our GitHub workflow for the gory details.

Edit diagrams

We use Excalidraw as primary tool to create sketches of architectural diagrams.

When exporting Excalidraw scenes, always use light mode and choose SVG as export format, as we have some CSS magic in place that automatically inverts colors SVGs so that they also look nicely when using dark mode.

Tenzir developers have access to our Exalidraw Documentation collection. For everyone else, we encourage to reach out to us on our Discord server to request changes to existing SVGs.