Skip to content

For agents

The HTML site is for humans. The same pages ship as Markdown. Prefer those URLs over scraping.

URLWhat it is
/llms.txtIndex (title + .md link for every page)
/llms-full.txtAll pages concatenated
/guide/stills.mdExample: any page path plus .md

Content-Type is text/markdown or text/plain. docs:dev, docs:preview, and the built site all serve them.

Read in this order

  1. What this is — two speeds, what stays in the app
  2. Getting started — install + first shot
  3. Stills — storyboard loop (do this before video)
  4. Examples — this site’s own walk as PNGs
  5. Writing a walk — lift recipe
  6. Cursor — show stills and walk.mp4 in the thread
  7. API overview — exported names
  8. Environment variables — flags

Then open a single .md for the topic you are changing.

Rules that bite

  • One spec. E2E_DEMO does not fork the story. Keep expects on.
  • shot on the teaching click/fill/point — not a raw Playwright screenshot, not demoScreenshot after demoFocus. Keep shot on the video run; Playwemo does not hold the ring or write a still while recordVideo is on (Video).
  • Do not minify overlay or cursor inits (addInitScript serializes function source).
  • Persona ids are strings. Product selectors live in the consumer’s configureDemoWalk.
  • To show a still or walk.mp4 in Cursor chat, copy it to /opt/cursor/artifacts and emit an <img> / <video> tag. See Cursor.

GitHub raw also works if you have the repo, for example https://raw.githubusercontent.com/DragonMastery/playwemo/apex/docs/guide/stills.md.

Released under the MIT License.