Contents

Extend

The kit is built to be extended by the same rules it follows itself. Each kind of change has one place to start, and the type checker and tests point at whatever else is missing.

To addStart inGuide
A blocksrc/blocksAdd a block
A kind of content with its own pagessrc/registry/index.tsAdd a module
A languagesrc/i18n/locales.tsAdd a language
Default colourssrc/theme/tokens.tsTheme colours

Before you start, read CLAUDE.md at the root of the repository: it lists the conventions, and tests/unit/conventions.test.ts enforces the ones a machine can check. The short version:

  • No brand, company or customer names in code, samples or seeds. The demo uses the fictional audio brand Varde; older test fixtures use a fictional pump maker, Brisk Pumps.
  • No hand-kept lists of collection slugs outside src/registry: derive them from the config or the registry.
  • Text editors write is localized, and admin labels are short and plain.
  • Visitor-facing words come from src/messages/*.json, with the same keys in every file.
  • Cache refreshes use revalidateTag(tag, { expire: 0 }).
  • New dependencies only when unavoidable, and only under MIT, ISC, BSD, Apache-2.0 or (for fonts) OFL.

These guides ship with Tolk Starter 0.6.0: buyers get the same pages in their repository, next to the code they describe.