Skip to content

docs: document playground example maintenance workflow #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TharmiganK merged 1 commit into from
Aug 12, 2026
Merged

docs: document playground example maintenance workflow #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Useful root scripts:
Guidance for `apps/web` and related frontend work:

- **shadcn UI primitives** live under `apps/web/src/components/ui/`. **Do not edit files in that directory** unless it is clearly necessary (for example, a defect that cannot be fixed by composing or wrapping components elsewhere). Prefer new or adjusted code outside `ui/`.
- Playground examples live in `examples/`. Do not edit the generated `apps/web/src/assets/examples.json` manually; regenerate it with `bun run --filter @playground/web gen:examples`. The initial example is selected by `DEFAULT_FILE` in `apps/web/src/components/file-route-sync.tsx`; update it when changing the default example.
- Example output is covered by Playwright golden files in `e2e/fixtures/examples/`. After an intentional example or runtime-output change, refresh and review them with `bun test:e2e:update-examples`. Update service-example requests and responses in `e2e/tests/examples.spec.ts` when applicable.

## Task completion

Expand Down
Loading