Skip to content

Agent Workflows

This document gives AI agents deterministic workflows for common tasks.

1) Add or modify SDK behavior (packages/core)

  1. Locate public API touchpoints in packages/core/src/hooks/index.ts.
  2. Implement changes in packages/core/src/hooks/**.
  3. Ensure exports remain consistent with packages/core/package.json.
  4. Run:
    • pnpm --filter @grist-widget-sdk/core build
    • pnpm --filter @grist-widget-sdk/core test
  5. Update docs when behavior or contracts change.

2) Update widgets example app (apps/widgets)

  1. Keep app-only concerns inside apps/widgets.
  2. Use public SDK imports only.
  3. Run:
    • pnpm --filter grist-widget-examples build
    • pnpm --filter grist-widget-examples lint
    • pnpm --filter grist-widget-examples typecheck

3) Update docs (apps/docs)

  1. Keep AI guidance under apps/docs/files/.
  2. Keep docs concise and command-first.
  3. Run:
    • pnpm --filter docs docs:build

4) Cross-workspace changes

When changing SDK + app together:

  1. Modify packages/core first.
  2. Update consuming code in apps/widgets and/or template.
  3. Run monorepo checks:
    • pnpm build
    • pnpm 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.