https://github.com/tenzir/docs
Tenzir Documentation
https://github.com/tenzir/docs
astro docs documentation starlight-astro tenzir
Last synced: about 1 year ago
JSON representation
Tenzir Documentation
- Host: GitHub
- URL: https://github.com/tenzir/docs
- Owner: tenzir
- Created: 2025-02-01T09:29:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T16:44:33.000Z (about 1 year ago)
- Last Synced: 2025-04-07T17:34:41.356Z (about 1 year ago)
- Topics: astro, docs, documentation, starlight-astro, tenzir
- Language: MDX
- Homepage: https://docs.tenzir.com
- Size: 3.97 MB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog/README.md
Awesome Lists containing this project
README
# Tenzir Documentation
This repository hosts the documentation of [Tenzir](https://tenzir.com).
## 🚧 WORK IN PROGRESS 🚧
The content in this repository is not yet authoritative. If you look for the
Tenzir documentation, go to [docs.tenzir.com](https://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](https://tenzir.github.io/docs).
## ☑️ TODOs
### Structure
- [x] Split nav at the top
- [x] Render API docs based on OpenAPI spec
- [x] Generate a sitemap at build time
- [x] Publish to GitHub Pages
- [x] Implement broken links check
- [x] Upgrade to Starlight 0.32 and re-implement Starlight Utils
- [x] Make logo href be tenzir.com
- [x] Rename *Documentation* to *Docs* in header
- [x] Tweak `index.mdx` title
- [x] Consider https://github.com/rehypejs/rehype-external-links
### CI / Automation
- [x] Update `tenzir.yaml.example` via CI
- [x] Update OpenAPI spec via CI
- [x] Update `tql.tmLanguage.json` via CI
- [x] Create consolidated Node & Platform changelog
- [x] Figure out how to use changesets
- [x] Update `changelog.mdx` in this repo
- [ ] Create CI job in tenzir/tenzir
- [ ] Create CI job in tenzir/platform
### Style
- [x] Hoist SVGs and apply auto-darkmode
- [x] TQL syntax highlighting
- [x] Fix sliding top nav bar on Firefox
- [x] Fix sizing calculator iframe height (CSS?)
- [ ] Fix github-{light,dark} syntax theme selection
- [x] Fix Integrations tab not being bold font inside
- [ ] Do CSS magic to fuse subsequent TQL code blocks
- [x] Apply CSS and get a facelift
- [ ] Style Asides to match design system
### Content
- [x] Landing page
- [x] FAQs
- [x] Integrations
- [x] Explanations
- [x] Tutorials
- [x] Guides
- [ ] Quickstart
- [ ] Reference
- [x] Language
- [ ] Operators
- [ ] Functions
- [x] Configuration
- [x] Platform CLI
- [x] 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:
```bash
pnpm install
```
Then view the docs locally:
```bash
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](https://starlight.astro.build/), read [Astro's
documentation](https://docs.astro.build), or jump into [Tenzir's Discord
server](https://docs.tenzir.com/discord).