This repository is a pnpm workspace. The docs site lives beside the product app so protocol documentation can evolve with the packages it describes.
Install
pnpm installRun the docs
pnpm --filter @lss/docs devThe docs app is intended to deploy as its own Vercel project with project root apps/lss-docs and site URL https://lss.notdhruv.com.
Run the product demo
pnpm --filter @lss/web devThe web app demonstrates creator, reader, ticket, and deck flows. The docs should explain those flows without importing runtime code from @lss/web.
Package responsibilities
| Package | Responsibility |
|---|---|
@lss/protocol | Payload shape, canonical bytes, Ed25519 signatures, fragments, checksums, and reconstruction |
@lss/carrier | Carrier artifacts, 24 by 24 visual frame codecs, blue-channel cell modulation, browser/file scan metrics, audio marker/text carriers, and Node MP4 carrier helpers |
@lss/embedder | Deterministic visual region frame plans, ultrasonic tone plans, and PCM tone rendering for package-level experiments |
@lss/reader | Simulated detector reads over protocol candidate fragments |
@lss/resolver | Demo action mapping for already-verified signed payloads |
Development habit
When adding docs, start with the builder question the page answers. Diagrams should be written as Mermaid directives so beautiful-mermaid renders them to SVG during the Astro build.