{"id":25373911,"url":"https://github.com/tenzir/docs","last_synced_at":"2025-04-09T09:15:46.242Z","repository":{"id":277573332,"uuid":"925606629","full_name":"tenzir/docs","owner":"tenzir","description":"Tenzir Documentation","archived":false,"fork":false,"pushed_at":"2025-04-07T16:44:33.000Z","size":4164,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-07T17:34:41.356Z","etag":null,"topics":["astro","docs","documentation","starlight-astro","tenzir"],"latest_commit_sha":null,"homepage":"https://docs.tenzir.com","language":"MDX","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tenzir.png","metadata":{"files":{"readme":"README.md","changelog":"changelog/README.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["tenzir"]}},"created_at":"2025-02-01T09:29:09.000Z","updated_at":"2025-04-07T16:24:23.000Z","dependencies_parsed_at":"2025-04-07T17:38:28.112Z","dependency_job_id":null,"html_url":"https://github.com/tenzir/docs","commit_stats":null,"previous_names":["tenzir/docs-starlight","tenzir/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenzir%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenzir%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenzir%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenzir%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tenzir","download_url":"https://codeload.github.com/tenzir/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248008628,"owners_count":21032556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["astro","docs","documentation","starlight-astro","tenzir"],"created_at":"2025-02-15T03:19:43.240Z","updated_at":"2025-04-09T09:15:46.230Z","avatar_url":"https://github.com/tenzir.png","language":"MDX","funding_links":["https://github.com/sponsors/tenzir"],"categories":[],"sub_categories":[],"readme":"# Tenzir Documentation\n\nThis repository hosts the documentation of [Tenzir](https://tenzir.com).\n\n## 🚧 WORK IN PROGRESS 🚧  \n\nThe content in this repository is not yet authoritative. If you look for the\nTenzir documentation, go to [docs.tenzir.com](https://docs.tenzir.com).\n\nWe are in the process of migrating our docs from Docusaurus to Starlight. You\ncan find a preview of the new documentation at\n[tenzir.github.io/docs](https://tenzir.github.io/docs).\n\n## ☑️ TODOs\n\n### Structure\n\n- [x] Split nav at the top\n- [x] Render API docs based on OpenAPI spec\n- [x] Generate a sitemap at build time\n- [x] Publish to GitHub Pages\n- [x] Implement broken links check\n- [x] Upgrade to Starlight 0.32 and re-implement Starlight Utils\n- [x] Make logo href be tenzir.com\n- [x] Rename *Documentation* to *Docs* in header\n- [x] Tweak `index.mdx` title\n- [x] Consider https://github.com/rehypejs/rehype-external-links\n\n### CI / Automation\n\n- [x] Update `tenzir.yaml.example` via CI\n- [x] Update OpenAPI spec via CI\n- [x] Update `tql.tmLanguage.json` via CI\n- [x] Create consolidated Node \u0026 Platform changelog\n  - [x] Figure out how to use changesets\n  - [x] Update `changelog.mdx` in this repo\n  - [ ] Create CI job in tenzir/tenzir\n  - [ ] Create CI job in tenzir/platform\n\n### Style\n\n- [x] Hoist SVGs and apply auto-darkmode\n- [x] TQL syntax highlighting\n- [x] Fix sliding top nav bar on Firefox\n- [x] Fix sizing calculator iframe height (CSS?)\n- [ ] Fix github-{light,dark} syntax theme selection\n- [x] Fix Integrations tab not being bold font inside\n- [ ] Do CSS magic to fuse subsequent TQL code blocks\n- [x] Apply CSS and get a facelift\n- [ ] Style Asides to match design system\n\n### Content\n\n- [x] Landing page\n- [x] FAQs\n- [x] Integrations\n- [x] Explanations\n- [x] Tutorials\n- [x] Guides\n  - [ ] Quickstart\n- [ ] Reference\n  - [x] Language\n  - [ ] Operators\n  - [ ] Functions\n  - [x] Configuration\n  - [x] Platform CLI\n  - [x] Glossary\n\n### Legal\n\n- [ ] SBOM at `/sbom`\n- [ ] Privacy Statement (or link to it)\n\n### 🚀 Relaunch\n\n- [ ] Fix all broken links and uncomment link checking in CI\n- [ ] Replace `site` and `base` in `astro.config.mjs`\n\n## ✊ Usage\n\nInstall the web framework dependencies:\n\n```bash\npnpm install\n```\n\nThen view the docs locally:\n\n```bash\npnpm dev\n```\n\nHere's an summary about frequently used commands:\n\n| Command                   | Action                                           |\n| :------------------------ | :----------------------------------------------- |\n| `pnpm install`            | Installs dependencies                            |\n| `pnpm dev`                | Starts local dev server at `localhost:4321`      |\n| `pnpm build`              | Build your production site to `./dist/`          |\n| `pnpm preview`            | Preview your build locally, before deploying     |\n| `pnpm astro ...`          | Run CLI commands like `astro add`, `astro check` |\n| `pnpm astro -- --help`    | Get help using the Astro CLI                     |\n\n## 🙋 Help\n\nCheck out [Starlight’s docs](https://starlight.astro.build/), read [Astro's\ndocumentation](https://docs.astro.build), or jump into [Tenzir's Discord\nserver](https://docs.tenzir.com/discord).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftenzir%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftenzir%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftenzir%2Fdocs/lists"}