TeachKit project

TeachKit / Design system

Documentation v0.1 · Released product

Design system contents

Implementation and maintenance

Reproduce captures safely

Render actual source UI with real owner content and local simulation, then review the complete image set.

On this page

Commands

node scripts/design-system/audit-teachkit.mjs ../teachkit-app
node scripts/design-system/prepare-teachkit-fixture.mjs ../teachkit-app # Owner-scoped SELECTs; ignored output only.
node scripts/design-system/capture-teachkit.mjs ../teachkit-app
python3 scripts/design-system/build-teachkit-content.py
node scripts/design-system/verify-design-systems.mjs http://localhost:3000

Isolation

Isolation
BoundaryImplementation
SourceDisposable /tmp snapshot; node_modules linked; original repo not edited
SecretsNo .env, Git data, user export or credentials copied
AuthLocal session and temporary make-class server wrapper replacement
APISource API routes removed; all localhost API responses intercepted
Course contentOnly Thomas-owned course/lesson SELECTs; no student records. Creator configuration fields not selected are unconfigured local states, not live account assertions.
External networkGET-only allowlisted font, image and video hosts; external writes blocked
Resolution2× DPR; PNG originals plus lossless component/high-quality screen WebP
CleanupBrowser/server stopped and temporary source removed

QC acceptance

  • Reject auth redirects, loading editors, blank media regions and missing covers.
  • Await font loading, image decoding and hydration. Providers can maintain network activity; a generic network-idle wait is insufficient.
  • Pass stable progress arrays/maps as the actual learner route does; default object props can repeatedly reset lesson effects and embeds.
  • Keep compact controls at native width and measure full popup bounds before cropping.
  • For tall screen captures, expand viewport height to content height so fixed save controls sit at the captured page bottom.
  • Use unique filenames for screens and component details; verify intrinsic dimensions against every manifest record.
  • Review desktop and phone images, including full-page captures, in contact sheets and at useful original resolution.
  • Open images inside the actual documentation viewer and verify fit, pixel inspection, Escape and return focus.

Retained files

Public assets and provenance live in public/design-systems/teachkit. PNG originals remain ignored in uploads/work/teachkit-design-system. Temporary owner-course fixtures are removed after review and can be regenerated with the owner-scoped preparation script. Capture templates and authored documentation builders are retained under scripts/design-system for reproducibility; the live app imports none of those fixtures.

Reference downloads

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