Skip to content

t1k:docs-site

FieldValue
Modulet1k-maintainer
Version2.18.3
Effortmedium
Tools

Keywords: dispatch, docs, docs-site, generate, pagefind, regenerate, ssot, starlight, website

/t1k:docs-site
[--local | --explain]

Docs at t1k.the1studio.org (Cloudflare Pages + Access). Repo: The1Studio/theonekit-docs.

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.

Each kit’s release workflow emits repository_dispatch event_type: kit-releasedtheonekit-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).

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.

Terminal window
node scripts/generate-content.mjs --local
# reads local kit clones; no GitHub fetch
# one kit only:
node scripts/generate-content.mjs --local --kit theonekit-unity

Use --local to test generator changes or debug output without touching the live site. Kit registry: scripts/kits.config.json.

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.
ItemValue
RepoThe1Studio/theonekit-docs
Hostingt1k.the1studio.org (Cloudflare Pages + Access)
Generatorscripts/generate-content.mjs
Kit registryscripts/kits.config.json
Deploy workflow.github/workflows/rebuild-and-deploy.yml
GitHub Appt1k-ci-sync App ID 3356613
  • 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-release gate prevents spurious rebuilds from non-release commits, but it also means draft commits don’t trigger a rebuild. Use --local for development iteration.
  • Cloudflare Accesst1k.the1studio.org requires org authentication. Unauthenticated users see a login wall, not the docs. This is intentional (internal-only scope per docs/audience-scope.md).