GuideShot docs
A small vocabulary for durable guides.
You will learn which concerns belong in recipes, which belong in project code, and why GuideShot separates capture from composition.
The eight pieces
Recipe
The declarative source of truth for one visual explanation.
Target
A stable product-owned name attached to a meaningful element.
Profile
The browser environment: viewport, pixel ratio, timezone, and motion.
Dimension
A finite axis such as locale, theme, role, plan, or feature state.
Scenario
Reviewed TypeScript that creates authenticated or seeded state.
Capture
Sanitized pixels plus the measured geometry of resolved targets.
Composition
Offline rendering of callouts, emphasis, connectors, and labels.
Manifest
The published index of variants, intrinsic dimensions, hashes, and alt text.
Intent in recipes, state in adapters
Recipes stay portable because they contain data. Scenarios and dimensions can use project code because they are reviewed application adapters.
A recipe can request an authenticated workspace without knowing how your application creates one. The scenario returns safe browser state; the recipe only names the scenario and its synthetic inputs.
Capture once, explain many ways
A capture is expensive and connected to the running app. Composition is deterministic and can run again without a browser.
Changing callout copy, connector placement, spotlight strength, or output format can reuse a valid sanitized capture. A changed page, target, profile, dimension, or scenario produces a new capture identity.