Agent Workflows
This document gives AI agents deterministic workflows for common tasks.
1) Add or modify SDK behavior (packages/core)
- Locate public API touchpoints in
packages/core/src/hooks/index.ts. - Implement changes in
packages/core/src/hooks/**. - Ensure exports remain consistent with
packages/core/package.json. - Run:
pnpm --filter @grist-widget-sdk/core buildpnpm --filter @grist-widget-sdk/core test
- Update docs when behavior or contracts change.
2) Update widgets example app (apps/widgets)
- Keep app-only concerns inside
apps/widgets. - Use public SDK imports only.
- Run:
pnpm --filter grist-widget-examples buildpnpm --filter grist-widget-examples lintpnpm --filter grist-widget-examples typecheck
3) Update docs (apps/docs)
- Keep AI guidance under
apps/docs/files/. - Keep docs concise and command-first.
- Run:
pnpm --filter docs docs:build
4) Cross-workspace changes
When changing SDK + app together:
- Modify
packages/corefirst. - Update consuming code in
apps/widgetsand/or template. - Run monorepo checks:
pnpm buildpnpm test
5) Pre-PR sanity checklist
- Paths and package names are current.
- No stale references to removed directories.
- Commands in docs are executable.
- Public API changes are documented.