Tenzir Documentation

This repository hosts the documentation of Tenzir.

🚧 WORK IN PROGRESS 🚧

The content in this repository is not yet authoritative. If you look for the Tenzir documentation, go to docs.tenzir.com.

We are in the process of migrating our docs from Docusaurus to Starlight. You can find a preview of the new documentation at tenzir.github.io/docs.

☑️ TODOs

Structure

• Split nav at the top
• Render API docs based on OpenAPI spec
• Generate a sitemap at build time
• Publish to GitHub Pages
• Implement broken links check
• Upgrade to Starlight 0.32 and re-implement Starlight Utils
• Make logo href be tenzir.com
• Rename Documentation to Docs in header
• Tweak index.mdx title
• Consider https://github.com/rehypejs/rehype-external-links

CI / Automation

• Update tenzir.yaml.example via CI
• Update OpenAPI spec via CI
• Update tql.tmLanguage.json via CI
• Create consolidated Node & Platform changelog
  • Figure out how to use changesets
  • Update changelog.mdx in this repo
  • Create CI job in tenzir/tenzir
  • Create CI job in tenzir/platform

Style

• Hoist SVGs and apply auto-darkmode
• TQL syntax highlighting
• Fix sliding top nav bar on Firefox
• Fix sizing calculator iframe height (CSS?)
• Fix github-{light,dark} syntax theme selection
• Fix Integrations tab not being bold font inside
• Do CSS magic to fuse subsequent TQL code blocks
• Apply CSS and get a facelift
• Style Asides to match design system

Content

• Landing page
• FAQs
• Integrations
• Explanations
• Tutorials
• Guides
  • Quickstart
• Reference
  • Language
  • Operators
  • Functions
  • Configuration
  • Platform CLI
  • Glossary

Legal

• SBOM at /sbom
• Privacy Statement (or link to it)

🚀 Relaunch

• Fix all broken links and uncomment link checking in CI
• Replace site and base in astro.config.mjs

✊ Usage

Install the web framework dependencies:

pnpm install

Then view the docs locally:

pnpm dev

Here's an summary about frequently used commands:

Command	Action
pnpm install	Installs dependencies
pnpm dev	Starts local dev server at localhost:4321
pnpm build	Build your production site to ./dist/
pnpm preview	Preview your build locally, before deploying
pnpm astro ...	Run CLI commands like astro add, astro check
pnpm astro -- --help	Get help using the Astro CLI

🙋 Help

Check out Starlight’s docs, read Astro's documentation, or jump into Tenzir's Discord server.