Start Here for AI Agents

Use this page as the canonical entrypoint when an AI agent starts working in this repository.

Root README link target

Point the root README to:

• /apps/docs/files/start-here.md in-repo
• /files/start-here in the VitePress site

Copy/paste prompt context

Use this compact context in agent system prompts:

Repository: grist-widget-sdk (pnpm workspaces + Turborepo)
Main package: packages/core => @grist-widget-sdk/core (tsup library, public API)
Consumer app: apps/widgets (Vite + React example app)
Docs: apps/docs (VitePress), AI guides under apps/docs/files
Template: templates/grist-widget-template-vite

Rules:
- Keep changes scoped and minimal.
- Respect package boundaries.
- Use only public SDK exports (no internal path imports).
- Prefer useGrist()/provider abstractions over direct grist global usage in app code.
- Update docs in apps/docs/files when behavior/contracts change.

Validation:
- pnpm --filter @grist-widget-sdk/core build
- pnpm --filter @grist-widget-sdk/core test
- pnpm --filter grist-widget-examples build
- pnpm --filter docs docs:build

What to read next

1. apps/docs/files/AGENT.md
2. apps/docs/files/architecture.md
3. apps/docs/files/conventions.md
4. apps/docs/files/agent-workflows.md