Skip to content

Contributing

See CONTRIBUTING.md at the repo root for the full command table.

CommandWhat it does
bun run checkLibrary typecheck + tests
bun run docs:devVitePress on port 5173
bun run docs:e2eFast dogfood storyboard
bun run docs:e2e:demoOverlay + stills + walk.mp4

The library uses tsdown with minify: false. Playwright addInitScript(fn) serializes function source. Overlay and cursor inits must stay self-contained. @playwright/test is a peer.

After an API change, update the matching page under API in the same PR. Site stills come from shot in e2e/docs-walk.spec.ts — see Dogfood.

License: MIT — Copyright © 2026 Dragon Mastery.

Released under the MIT License.