t1k:docs-site
| Field | Value |
|---|---|
| Module | t1k-maintainer |
| Version | 2.18.3 |
| Effort | medium |
| Tools | — |
Keywords: dispatch, docs, docs-site, generate, pagefind, regenerate, ssot, starlight, website
How to invoke
Section titled “How to invoke”/t1k:docs-site[--local | --explain]TheOneKit Docs Site
Section titled “TheOneKit Docs Site”Docs at t1k.the1studio.org (Cloudflare Pages + Access). Repo: The1Studio/theonekit-docs.
Auto-Update Guarantee
Section titled “Auto-Update Guarantee”The site auto-regenerates and redeploys on EVERY kit OR module release. You never hand-update the website.
This is a hard guarantee — any docs work that involves editing the generated pages directly is wrong by design.
Dispatch Wiring
Section titled “Dispatch Wiring”Each kit’s release workflow emits repository_dispatch event_type: kit-released → theonekit-docs rebuild-and-deploy.yml → regenerate + redeploy to Cloudflare Pages. Gated on did-release output so module-only bumps (no kit-level tag) also fire the dispatch. Authentication uses the t1k-ci-sync GitHub App (App ID 3356613).
Nightly Fallback
Section titled “Nightly Fallback”cron: '0 7 * * *' — safety-net rebuild that catches any dispatch that was dropped or missed. Site is guaranteed fresh within 24h even if dispatch fails.
Local Debug (--local)
Section titled “Local Debug (--local)”node scripts/generate-content.mjs --local# reads local kit clones; no GitHub fetch# one kit only:node scripts/generate-content.mjs --local --kit theonekit-unityUse --local to test generator changes or debug output without touching the live site. Kit registry: scripts/kits.config.json.
SSOT No-Hand-Edit Gate
Section titled “SSOT No-Hand-Edit Gate”check-generated-untouched CI gate fails any PR that commits files under src/content/docs/**.
- Generated content under
src/content/docs/is EPHEMERAL — rebuilt on every deploy, never committed. - To fix a generated page: edit the source in the owning kit, release, let the site rebuild.
- Hand-written content goes ONLY in
src/content/handwritten/**— this path is exempt from the gate.
Pointers
Section titled “Pointers”| Item | Value |
|---|---|
| Repo | The1Studio/theonekit-docs |
| Hosting | t1k.the1studio.org (Cloudflare Pages + Access) |
| Generator | scripts/generate-content.mjs |
| Kit registry | scripts/kits.config.json |
| Deploy workflow | .github/workflows/rebuild-and-deploy.yml |
| GitHub App | t1k-ci-sync App ID 3356613 |
Gotchas
Section titled “Gotchas”- Never commit to
src/content/docs/**— the gate treats any such commit as a violation. Revert and fix the source kit instead. - Dispatch requires a released tag — the
did-releasegate prevents spurious rebuilds from non-release commits, but it also means draft commits don’t trigger a rebuild. Use--localfor development iteration. - Cloudflare Access —
t1k.the1studio.orgrequires org authentication. Unauthenticated users see a login wall, not the docs. This is intentional (internal-only scope perdocs/audience-scope.md).