TeachKit project

TeachKit / Design system

Documentation v0.1 · Released product

Design system contents

Implementation and maintenance

Maintain and extend the reference

Keep the design-system documentation connected to the product rather than letting it become a second implementation.

On this page

Refresh workflow

  • Audit the current source and compare hashes.
  • Identify affected component families and their patterns.
  • Refresh only actual owner course content through read-only, scoped queries when needed.
  • Update capture imports/props without inventing missing course content.
  • Render in a disposable snapshot and inspect every affected image.
  • Run evidence, route, lint and build checks before preview.

Change rules

Change rules
ChangeRequired review
Palette/fontFoundations, contrast, all affected captures
Component propsContracts, examples and specimen fixtures
Course workflowPattern steps, source references and applied screens
Backend behaviorPersistence/authorization evidence and failure handling
Theme supportActual source implementation plus desktop/phone coverage
New projectIts own tokens, source audit, fixture policy and readiness register

Template boundary

Reuse the shared page schema, searchable outline, project tab and image inspection. Do not copy TeachKit’s palette, corner geometry, learner concepts or readiness claims into another product. Every new system needs its own source-specific evidence.

Reference downloads

Source audit: 2026-10-07 · Revision d8cf23d0a329 · Documentation v0.1