How This Docs Site Works (Meta)

A docs site for a framework should answer the implicit question every visitor brings: "OK, but is this thing real? Could I actually build something with it?". The most honest answer is to be one yourself.

This site is a tinkerdown app — markdown files, one configuration file, no React. Every page you see is rendered by tinkerdown, which runs on top of LiveTemplate. The bug-finding loop is a feedback cycle: building the docs uncovers latent issues in the framework, and we fix them in the framework rather than working around them in the site.

The shape of the dogfood loop

finds a bug

new release

Author writes markdown

livetemplate/docs
site repo

fly.io deploy
tinkerdown serves

Reader hits the page

GitHub issue or e2e failure

livetemplate/tinkerdown
generic fix lands

GitHub Action sync
from source repos

Concrete examples this site found and the framework absorbed:

None of these would have surfaced in unit tests. They needed a real, reasonably-trafficked site running with real assets.

Live numbers from this very page

The catalog this site exposes is itself driven by the same lvt-source="patterns" REST binding the site uses everywhere:

Connecting...

That number isn't hardcoded. It's a server-side template render, executed when this page loaded, against a live JSON endpoint of a separate fly.io deployment.

What's in the site that isn't in tinkerdown core

A few site-specific moving parts live in the livetemplate/docs repo, not in tinkerdown itself:

Piece Lives in Why not in tinkerdown
Source-of-truth matrix (which repo owns which doc) content/_meta/source-of-truth.{md,yaml} Specific to this docs site's content layout
Sync program (cross-repo content mirror) cmd/sync/ (Go) Specific to this site's release-tag-driven sync model
GitHub Actions sync workflow .github/workflows/sync.yml Per-deployment ops choice
Recipes content (this page included) content/recipes/ Just markdown

Everything else — proxy routing, theme tokens, mermaid bundling, lvt-source REST, wss:// scheme detection, edit-on-GitHub links — lives in tinkerdown as generic features. The discipline is: if the site needs it, tinkerdown should provide it for any site.

Reading list