Skip to content

Fix AppKit template documentation for LLMs #4291

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
keugenek merged 4 commits into from
Jan 15, 2026
+12 −4
Merged

Fix AppKit template documentation for LLMs #4291

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
07bf147
Emphasize typegen as required step after schema changes
keugenek Jan 9, 2026
2afcf50
Delete cli-linux-arm64
keugenek Jan 15, 2026
bbacaa1
Delete cli-linux
keugenek Jan 15, 2026
f7bd6d5
Update CLAUDE.md
keugenek Jan 15, 2026
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
16 changes: 12 additions & 4 deletions experimental/aitools/templates/appkit/template/{{.project_name}}/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,15 @@ export const querySchemas = {
};
```

**Step 3: Add visualization to your app**
**Step 3: Run typegen (REQUIRED after any schema change)**

```bash
npm run typegen
```

This regenerates `client/src/appKitTypes.d.ts` with your new query types. **Without this step, TypeScript will not recognize your query keys and builds will fail.**

**Step 4: Add visualization to your app**

```typescript
// client/src/App.tsx
Expand All @@ -45,9 +53,9 @@ import { BarChart } from '@databricks/appkit-ui/react';

**That's it!** The component handles data fetching, loading states, and rendering automatically.

**To refresh TypeScript types after adding queries:**
- Run `npm run typegen` OR run `npm run dev` - both auto-generate type definitions in `client/src/appKitTypes.d.ts`
- DO NOT manually edit `appKitTypes.d.ts`
**⚠️ CRITICAL: Always run `npm run typegen` after modifying files in `config/queries/`**
- DO NOT manually edit `client/src/appKitTypes.d.ts` - it is auto-generated
- If you see errors like `'"my_query"' is not assignable to parameter of type`, run `npm run typegen`

## Installation

Expand Down