@databricks/appkit-ui 0.12.0 → 0.12.1

package/docs/development.md

@@ -0,0 +1,22 @@
+# Development
+
+AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.
+
+## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
+
+* [Node.js](https://nodejs.org) v22+ environment with `npm`
+* Databricks CLI (v0.287.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
+* A new Databricks app with AppKit installed. See the [Quick start](./docs.md#quick-start) for more details.
+
+## Development flows[​](#development-flows "Direct link to Development flows")
+
+There are multiple supported development flows available with AppKit:
+
+1. **[Local development](./docs/development/local-development.md)**: Run the development server with hot reload for both UI and backend code. This is the default development flow and is suitable for most use cases.
+2. **[AI-assisted development](./docs/development/ai-assisted-development.md)**: Use an AI coding assistant to explore data, run CLI commands, and scaffold your app interactively.
+3. **[Remote Bridge](./docs/development/remote-bridge.md)**: Create a remote bridge to a deployed backend while keeping your queries and UI local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.
+
+## See also[​](#see-also "Direct link to See also")
+
+* [App management](./docs/app-management.md): Manage your AppKit application throughout its lifecycle using the Databricks CLI
+* [Architecture](./docs/architecture.md): Learn about the architecture of AppKit

package/docs/{docs/plugins → plugins}/analytics.md

@@ -5,7 +5,7 @@ Enables SQL query execution against Databricks SQL Warehouses.
 **Key features:**
 
 * File-based SQL queries with automatic type generation
-* Parameterized queries with type-safe [SQL helpers](/appkit/docs/api/appkit/Variable.sql.md)
+* Parameterized queries with type-safe [SQL helpers](./docs/api/appkit/Variable.sql.md)
 * JSON and Arrow format support
 * Built-in caching and retry logic
 * Server-Sent Events (SSE) streaming

package/docs/{docs/plugins → plugins}/custom-plugins.md

@@ -11,7 +11,7 @@ For a deeper understanding of the plugin structure, read on.
 
 ## Basic plugin example[​](#basic-plugin-example "Direct link to Basic plugin example")
 
-Extend the [`Plugin`](/appkit/docs/api/appkit/Class.Plugin.md) class and export with `toPlugin()`:
+Extend the [`Plugin`](./docs/api/appkit/Class.Plugin.md) class and export with `toPlugin()`:
 
 ```typescript
 import { Plugin, toPlugin } from "@databricks/appkit";
@@ -128,7 +128,7 @@ This pattern allows:
 
 ## Key extension points[​](#key-extension-points "Direct link to Key extension points")
 
-* **Route injection**: Implement `injectRoutes()` to add custom endpoints using [`IAppRouter`](/appkit/docs/api/appkit/TypeAlias.IAppRouter.md)
+* **Route injection**: Implement `injectRoutes()` to add custom endpoints using [`IAppRouter`](./docs/api/appkit/TypeAlias.IAppRouter.md)
 
 * **Lifecycle hooks**: Override `setup()`, and `shutdown()` methods
 
@@ -136,10 +136,10 @@ This pattern allows:
 
   <!-- -->
 
-  * **Cache management**: Access the cache service via `this.cache`. See [`CacheConfig`](/appkit/docs/api/appkit/Interface.CacheConfig.md) for configuration.
-  * **Telemetry**: Instrument your plugin with traces and metrics via `this.telemetry`. See [`ITelemetry`](/appkit/docs/api/appkit/Interface.ITelemetry.md).
+  * **Cache management**: Access the cache service via `this.cache`. See [`CacheConfig`](./docs/api/appkit/Interface.CacheConfig.md) for configuration.
+  * **Telemetry**: Instrument your plugin with traces and metrics via `this.telemetry`. See [`ITelemetry`](./docs/api/appkit/Interface.ITelemetry.md).
 
-* **Execution interceptors**: Use `execute()` and `executeStream()` with [`StreamExecutionSettings`](/appkit/docs/api/appkit/Interface.StreamExecutionSettings.md)
+* **Execution interceptors**: Use `execute()` and `executeStream()` with [`StreamExecutionSettings`](./docs/api/appkit/Interface.StreamExecutionSettings.md)
 
 **Consuming your plugin programmatically**
 
@@ -158,4 +158,4 @@ AppKit.myPlugin.myCustomMethod();
 
 ```
 
-See the [`Plugin`](/appkit/docs/api/appkit/Class.Plugin.md) API reference for complete documentation.
+See the [`Plugin`](./docs/api/appkit/Class.Plugin.md) API reference for complete documentation.

package/docs/{docs/plugins.md → plugins.md}

@@ -2,7 +2,7 @@
 
 Plugins are modular extensions that add capabilities to your AppKit application. They follow a defined lifecycle and have access to shared services like caching, telemetry, and streaming.
 
-For complete API documentation, see the [`Plugin`](/appkit/docs/api/appkit/Class.Plugin.md) class reference.
+For complete API documentation, see the [`Plugin`](./docs/api/appkit/Class.Plugin.md) class reference.
 
 ## Using plugins[​](#using-plugins "Direct link to Using plugins")
 
@@ -20,7 +20,7 @@ const AppKit = await createApp({
 
 ```
 
-For complete configuration options, see [`createApp`](/appkit/docs/api/appkit/Function.createApp.md).
+For complete configuration options, see [`createApp`](./docs/api/appkit/Function.createApp.md).
 
 ## Plugin phases[​](#plugin-phases "Direct link to Plugin phases")
 

package/{docs/docs.md → docs.md}

@@ -44,7 +44,7 @@ The command will guide you through the process of:
 * (optionally) deploying the app to Databricks
 * (optionally) running the app in development mode
 
-Learn more about the various [development flows](/appkit/docs/development.md) available with AppKit.
+Learn more about the various [development flows](./docs/development.md) available with AppKit.
 
 ### Deploy the app to Databricks[​](#deploy-the-app-to-databricks "Direct link to Deploy the app to Databricks")
 
@@ -59,6 +59,6 @@ This deploys the sample app to Databricks.
 
 ## Next steps[​](#next-steps "Direct link to Next steps")
 
-* **[App management](/appkit/docs/app-management.md)**: Manage your AppKit application throughout its lifecycle using the Databricks CLI
-* **[API reference](/appkit/docs/api/appkit.md)**: Explore the complete API documentation
-* **[Core concepts](/appkit/docs/core-principles.md)**: Learn about AppKit's design principles and architecture
+* **[App management](./docs/app-management.md)**: Manage your AppKit application throughout its lifecycle using the Databricks CLI
+* **[API reference](./docs/api/appkit.md)**: Explore the complete API documentation
+* **[Core concepts](./docs/core-principles.md)**: Learn about AppKit's design principles and architecture

package/llms.txt

@@ -1,18 +1,15 @@
 ## For AI Agents/Assistants
 
-To view specific documentation files referenced below, use the appkit CLI:
+The section names and doc paths below can be passed as the `<query>` argument:
 
 ```bash
-npx @databricks/appkit docs <path>
+npx @databricks/appkit docs <query>
 ```
 
-Examples:
-- View main documentation: `npx @databricks/appkit docs`
-- View specific file: `npx @databricks/appkit docs ./docs/docs.md`
-- View API reference: `npx @databricks/appkit docs ./docs/docs/api.md`
-- View component docs: `npx @databricks/appkit docs ./docs/docs/api/appkit-ui/components/Sidebar.md`
-
-The CLI will display the documentation content directly in the terminal.
+- View documentation index: `npx @databricks/appkit docs`
+- View a section: `npx @databricks/appkit docs "appkit-ui API reference"`
+- Full index (all API entries): `npx @databricks/appkit docs --full`
+- View specific doc: `npx @databricks/appkit docs ./docs/plugins/analytics.md`
 
 ---
 
@@ -21,141 +18,152 @@ The CLI will display the documentation content directly in the terminal.
 > Node.js + React SDK for Databricks Apps. Built for humans and AI.
 
 
-## Appkit
-
-- [Getting started](./docs/docs.md): Learn how to get started with AppKit.
-- [API reference](./docs/docs/api.md): This section contains the API reference for the AppKit packages.
-- [@databricks/appkit](./docs/docs/api/appkit.md): Core library for building Databricks applications with type-safe SQL queries,
-- [Abstract Class: AppKitError](./docs/docs/api./docs/Class.AppKitError.md): Base error class for all AppKit errors.
-- [Class: AuthenticationError](./docs/docs/api./docs/Class.AuthenticationError.md): Error thrown when authentication fails.
-- [Class: ConfigurationError](./docs/docs/api./docs/Class.ConfigurationError.md): Error thrown when configuration is missing or invalid.
-- [Class: ConnectionError](./docs/docs/api./docs/Class.ConnectionError.md): Error thrown when a connection or network operation fails.
-- [Class: ExecutionError](./docs/docs/api./docs/Class.ExecutionError.md): Error thrown when an operation execution fails.
-- [Class: InitializationError](./docs/docs/api./docs/Class.InitializationError.md): Error thrown when a service or component is not properly initialized.
-- [Abstract Class: Plugin<TConfig>](./docs/docs/api./docs/Class.Plugin.md): Base abstract class for creating AppKit plugins.
-- [Class: ResourceRegistry](./docs/docs/api./docs/Class.ResourceRegistry.md): Central registry for tracking plugin resource requirements.
-- [Class: ServerError](./docs/docs/api./docs/Class.ServerError.md): Error thrown when server lifecycle operations fail.
-- [Class: TunnelError](./docs/docs/api./docs/Class.TunnelError.md): Error thrown when remote tunnel operations fail.
-- [Class: ValidationError](./docs/docs/api./docs/Class.ValidationError.md): Error thrown when input validation fails.
-- [Enumeration: RequestedClaimsPermissionSet](./docs/docs/api./docs/Enumeration.RequestedClaimsPermissionSet.md): Permission set for Unity Catalog table access
-- [Enumeration: ResourceType](./docs/docs/api./docs/Enumeration.ResourceType.md): Resource types from schema $defs.resourceType.enum
-- [Function: appKitTypesPlugin()](./docs/docs/api./docs/Function.appKitTypesPlugin.md): Vite plugin to generate types for AppKit queries.
-- [Function: createApp()](./docs/docs/api./docs/Function.createApp.md): Bootstraps AppKit with the provided configuration.
-- [Function: createLakebasePool()](./docs/docs/api./docs/Function.createLakebasePool.md): Create a Lakebase pool with appkit's logger integration.
-- [Function: generateDatabaseCredential()](./docs/docs/api./docs/Function.generateDatabaseCredential.md): Generate OAuth credentials for Postgres database connection using the proper Postgres API.
-- [Function: getExecutionContext()](./docs/docs/api./docs/Function.getExecutionContext.md): Get the current execution context.
-- [Function: getLakebaseOrmConfig()](./docs/docs/api./docs/Function.getLakebaseOrmConfig.md): Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly.
-- [Function: getLakebasePgConfig()](./docs/docs/api./docs/Function.getLakebasePgConfig.md): Get Lakebase connection configuration for PostgreSQL clients.
-- [Function: getPluginManifest()](./docs/docs/api./docs/Function.getPluginManifest.md): Loads and validates the manifest from a plugin constructor.
-- [Function: getResourceRequirements()](./docs/docs/api./docs/Function.getResourceRequirements.md): Gets the resource requirements from a plugin's manifest.
-- [Function: getUsernameWithApiLookup()](./docs/docs/api./docs/Function.getUsernameWithApiLookup.md): Resolves the PostgreSQL username for a Lakebase connection.
-- [Function: getWorkspaceClient()](./docs/docs/api./docs/Function.getWorkspaceClient.md): Get workspace client from config or SDK default auth chain
-- [Function: isSQLTypeMarker()](./docs/docs/api./docs/Function.isSQLTypeMarker.md): Type guard to check if a value is a SQL type marker
-- [Interface: BasePluginConfig](./docs/docs/api./docs/Interface.BasePluginConfig.md): Base configuration interface for AppKit plugins
-- [Interface: CacheConfig](./docs/docs/api./docs/Interface.CacheConfig.md): Configuration for caching
-- [Interface: DatabaseCredential](./docs/docs/api./docs/Interface.DatabaseCredential.md): Database credentials with OAuth token for Postgres connection
-- [Interface: GenerateDatabaseCredentialRequest](./docs/docs/api./docs/Interface.GenerateDatabaseCredentialRequest.md): Request parameters for generating database OAuth credentials
-- [Interface: ITelemetry](./docs/docs/api./docs/Interface.ITelemetry.md): Plugin-facing interface for OpenTelemetry instrumentation.
-- [Interface: LakebasePoolConfig](./docs/docs/api./docs/Interface.LakebasePoolConfig.md): Configuration for creating a Lakebase connection pool
-- [Interface: PluginManifest](./docs/docs/api./docs/Interface.PluginManifest.md): Plugin manifest that declares metadata and resource requirements.
-- [Interface: RequestedClaims](./docs/docs/api./docs/Interface.RequestedClaims.md): Optional claims for fine-grained Unity Catalog table permissions
-- [Interface: RequestedResource](./docs/docs/api./docs/Interface.RequestedResource.md): Resource to request permissions for in Unity Catalog
-- [Interface: ResourceEntry](./docs/docs/api./docs/Interface.ResourceEntry.md): Internal representation of a resource in the registry.
-- [Interface: ResourceFieldEntry](./docs/docs/api./docs/Interface.ResourceFieldEntry.md): Defines a single field for a resource. Each field has its own environment variable and optional description.
-- [Interface: ResourceRequirement](./docs/docs/api./docs/Interface.ResourceRequirement.md): Declares a resource requirement for a plugin.
-- [Interface: StreamExecutionSettings](./docs/docs/api./docs/Interface.StreamExecutionSettings.md): Configuration for streaming execution with default and user-scoped settings
-- [Interface: TelemetryConfig](./docs/docs/api./docs/Interface.TelemetryConfig.md): OpenTelemetry configuration for AppKit applications
-- [Interface: ValidationResult](./docs/docs/api./docs/Interface.ValidationResult.md): Result of validating all registered resources against the environment.
-- [Type Alias: ConfigSchema](./docs/docs/api./docs/TypeAlias.ConfigSchema.md): Configuration schema definition for plugin config.
-- [Type Alias: IAppRouter](./docs/docs/api./docs/TypeAlias.IAppRouter.md): Express router type for plugin route registration
-- [Type Alias: ResourcePermission](./docs/docs/api./docs/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
-- [Type Alias: ToPlugin()<T, U, N>](./docs/docs/api./docs/TypeAlias.ToPlugin.md): Type Parameters
-- [Variable: sql](./docs/docs/api./docs/Variable.sql.md): SQL helper namespace
-- [@databricks/appkit-ui](./docs/docs/api/appkit-ui.md): The library provides a set of UI primitives for building Databricks apps in React.
-- [AreaChart](./docs/docs/api/appkit-ui/data/AreaChart.md): Area Chart component for trend visualization with filled areas.
-- [BarChart](./docs/docs/api/appkit-ui/data/BarChart.md): Bar Chart component for categorical comparisons.
-- [DataTable](./docs/docs/api/appkit-ui/data/DataTable.md): Production-ready data table with automatic data fetching and state management
-- [DonutChart](./docs/docs/api/appkit-ui/data/DonutChart.md): Donut Chart component (Pie chart with inner radius).
-- [HeatmapChart](./docs/docs/api/appkit-ui/data/HeatmapChart.md): Heatmap Chart component for matrix-style data visualization.
-- [LineChart](./docs/docs/api/appkit-ui/data/LineChart.md): Line Chart component for time-series and trend visualization.
-- [PieChart](./docs/docs/api/appkit-ui/data/PieChart.md): Pie Chart component for proportional data visualization.
-- [RadarChart](./docs/docs/api/appkit-ui/data/RadarChart.md): Radar Chart component for multi-dimensional data comparison.
-- [ScatterChart](./docs/docs/api/appkit-ui/data/ScatterChart.md): Scatter Chart component for correlation and distribution visualization.
-- [GenieChat](./docs/docs/api/appkit-ui/genie/GenieChat.md): Full-featured chat interface for a single Databricks AI/BI Genie space. Handles message streaming, conversation history, and auto-reconnection via SSE.
-- [GenieChatInput](./docs/docs/api/appkit-ui/genie/GenieChatInput.md): Auto-expanding textarea input with a send button for chat messages. Submits on Enter (Shift+Enter for newline).
-- [GenieChatMessage](./docs/docs/api/appkit-ui/genie/GenieChatMessage.md): Renders a single Genie message bubble with optional expandable SQL query attachments.
-- [GenieChatMessageList](./docs/docs/api/appkit-ui/genie/GenieChatMessageList.md): Scrollable message list that renders Genie chat messages with auto-scroll, skeleton loaders, and a streaming indicator.
-- [Styling](./docs/docs/api/appkit-ui/styling.md): This guide covers how to style AppKit UI components using CSS variables and theming.
-- [Accordion](./docs/docs/api/appkit-ui/ui/Accordion.md): Collapsible content sections organized in a vertical stack
-- [Alert](./docs/docs/api/appkit-ui/ui/Alert.md): Displays important information with optional icon and multiple variants
-- [AlertDialog](./docs/docs/api/appkit-ui/ui/AlertDialog.md): Modal dialog that interrupts the user with critical information requiring immediate action
-- [AspectRatio](./docs/docs/api/appkit-ui/ui/AspectRatio.md): Container that maintains a specific aspect ratio for its content
-- [Avatar](./docs/docs/api/appkit-ui/ui/Avatar.md): Displays user profile picture or initials in a circular container
-- [Badge](./docs/docs/api/appkit-ui/ui/Badge.md): Small label for displaying status, categories, or counts
-- [Breadcrumb](./docs/docs/api/appkit-ui/ui/Breadcrumb.md): Navigation component showing the current page's location in the site hierarchy
-- [Button](./docs/docs/api/appkit-ui/ui/Button.md): Clickable button with multiple variants and sizes
-- [ButtonGroup](./docs/docs/api/appkit-ui/ui/ButtonGroup.md): Container for grouping related buttons together with shared borders
-- [Calendar](./docs/docs/api/appkit-ui/ui/Calendar.md): Date picker component for selecting single dates or date ranges
-- [Card](./docs/docs/api/appkit-ui/ui/Card.md): Container for grouping related content with header, body, and footer sections
-- [Carousel](./docs/docs/api/appkit-ui/ui/Carousel.md): Slideshow component for cycling through content with navigation controls
-- [ChartContainer](./docs/docs/api/appkit-ui/ui/ChartContainer.md): Container for rendering data visualizations using Recharts
-- [Checkbox](./docs/docs/api/appkit-ui/ui/Checkbox.md): Checkbox input for selecting multiple options
-- [Collapsible](./docs/docs/api/appkit-ui/ui/Collapsible.md): Interactive component that expands and collapses content
-- [Command](./docs/docs/api/appkit-ui/ui/Command.md): Command palette for keyboard-driven navigation and actions
-- [ContextMenu](./docs/docs/api/appkit-ui/ui/ContextMenu.md): Menu triggered by right-clicking an element
-- [Dialog](./docs/docs/api/appkit-ui/ui/Dialog.md): Modal dialog that overlays the page content
-- [Drawer](./docs/docs/api/appkit-ui/ui/Drawer.md): Draggable panel that slides in from screen edges
-- [DropdownMenu](./docs/docs/api/appkit-ui/ui/DropdownMenu.md): Menu that displays when triggered by a button or element
-- [Empty](./docs/docs/api/appkit-ui/ui/Empty.md): Empty state component for displaying no-data scenarios
-- [Field](./docs/docs/api/appkit-ui/ui/Field.md): Form field wrapper with label and input positioning
-- [FormControl](./docs/docs/api/appkit-ui/ui/FormControl.md): Wrapper for form control elements with accessibility attributes
-- [HoverCard](./docs/docs/api/appkit-ui/ui/HoverCard.md): Content card that appears when hovering over an element
-- [Input](./docs/docs/api/appkit-ui/ui/Input.md): Text input field for single-line user input
-- [InputGroup](./docs/docs/api/appkit-ui/ui/InputGroup.md): Container for combining input fields with addons and buttons
-- [InputOTP](./docs/docs/api/appkit-ui/ui/InputOTP.md): One-time password input with individual character slots
-- [Item](./docs/docs/api/appkit-ui/ui/Item.md): Flexible container for list items with media, content, and actions
-- [Kbd](./docs/docs/api/appkit-ui/ui/Kbd.md): Visual representation of keyboard keys
-- [Label](./docs/docs/api/appkit-ui/ui/Label.md): Text label associated with form controls
-- [Menubar](./docs/docs/api/appkit-ui/ui/Menubar.md): Horizontal menu bar with dropdown menus
-- [NavigationMenu](./docs/docs/api/appkit-ui/ui/NavigationMenu.md): Horizontal navigation menu with dropdown submenus
-- [Pagination](./docs/docs/api/appkit-ui/ui/Pagination.md): Navigation component for paginated content
-- [Popover](./docs/docs/api/appkit-ui/ui/Popover.md): Floating content panel anchored to a trigger element
-- [Progress](./docs/docs/api/appkit-ui/ui/Progress.md): Visual indicator showing task completion percentage
-- [RadioGroup](./docs/docs/api/appkit-ui/ui/RadioGroup.md): Group of radio buttons for selecting a single option
-- [ResizableHandle](./docs/docs/api/appkit-ui/ui/ResizableHandle.md): Draggable handle for resizing panels
-- [ScrollArea](./docs/docs/api/appkit-ui/ui/ScrollArea.md): Container with custom scrollbars for overflow content
-- [Select](./docs/docs/api/appkit-ui/ui/Select.md): Dropdown control for selecting a value from a list
-- [Separator](./docs/docs/api/appkit-ui/ui/Separator.md): Visual divider line between content sections
-- [Sheet](./docs/docs/api/appkit-ui/ui/Sheet.md): Sliding panel that overlays content from screen edges
-- [Sidebar](./docs/docs/api/appkit-ui/ui/Sidebar.md): Collapsible navigation sidebar with mobile support
-- [Skeleton](./docs/docs/api/appkit-ui/ui/Skeleton.md): Loading placeholder with pulsing animation
-- [Slider](./docs/docs/api/appkit-ui/ui/Slider.md): Draggable input for selecting numeric values within a range
-- [Spinner](./docs/docs/api/appkit-ui/ui/Spinner.md): Animated loading indicator
-- [Switch](./docs/docs/api/appkit-ui/ui/Switch.md): Toggle control for switching between on and off states
-- [Table](./docs/docs/api/appkit-ui/ui/Table.md): Structured data display with rows and columns
-- [Tabs](./docs/docs/api/appkit-ui/ui/Tabs.md): Tabbed interface for organizing content into separate panels
-- [Textarea](./docs/docs/api/appkit-ui/ui/Textarea.md): Multi-line text input field
-- [Toaster](./docs/docs/api/appkit-ui/ui/Toaster.md): Toast notification system for displaying temporary messages
-- [Toggle](./docs/docs/api/appkit-ui/ui/Toggle.md): Button that toggles between pressed and unpressed states
-- [ToggleGroup](./docs/docs/api/appkit-ui/ui/ToggleGroup.md): Group of toggle buttons for selecting one or more options
-- [Tooltip](./docs/docs/api/appkit-ui/ui/Tooltip.md): Brief informational message that appears on hover
-- [App management](./docs/docs/app-management.md): Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps.
-- [Architecture](./docs/docs/architecture.md): AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions.
-- [Development](./docs/docs/category/development.md): Guides for developing AppKit applications
-- [Configuration](./docs/docs/configuration.md): This guide covers environment variables and configuration options for AppKit applications.
-- [Core principles](./docs/docs/core-principles.md): Learn about the fundamental concepts and principles behind AppKit.
-- [Development](./docs/docs/development.md): AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.
-- [AI-Assisted development](./docs/docs/development/ai-assisted-development.md): AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.
-- [LLM Guide](./docs/docs/development/llm-guide.md): This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.
-- [Local development](./docs/docs/development/local-development.md): Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.
-- [Project setup](./docs/docs/development/project-setup.md): This guide covers the recommended project structure and scaffolding for AppKit applications.
-- [Remote Bridge](./docs/docs/development/remote-bridge.md): Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.
-- [Type generation](./docs/docs/development/type-generation.md): AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.
-- [Plugins](./docs/docs/plugins.md): Plugins are modular extensions that add capabilities to your AppKit application. They follow a defined lifecycle and have access to shared services like caching, telemetry, and streaming.
-- [Analytics plugin](./docs/docs/plugins/analytics.md): Enables SQL query execution against Databricks SQL Warehouses.
-- [Caching](./docs/docs/plugins/caching.md): AppKit provides both global and plugin-level caching capabilities.
-- [Creating custom plugins](./docs/docs/plugins/custom-plugins.md): If you need custom API routes or background logic, implement an AppKit plugin. The fastest way is to use the CLI:
-- [Execution context](./docs/docs/plugins/execution-context.md): AppKit manages Databricks authentication via two contexts:
-- [Lakebase plugin](./docs/docs/plugins/lakebase.md): Currently, the Lakebase plugin currently requires a one-time manual setup to connect your Databricks App with your Lakebase database. An automated setup process is planned for an upcoming future release.
-- [Plugin management](./docs/docs/plugins/plugin-management.md): AppKit includes a CLI for managing plugins. All commands are available under npx @databricks/appkit plugin.
-- [Server plugin](./docs/docs/plugins/server.md): Provides HTTP server capabilities with development and production modes.
+## General docs
+
+- [Getting started](./docs.md): Learn how to get started with AppKit.
+- [API reference](./docs/api.md): This section contains the API reference for the AppKit packages.
+- [App management](./docs/app-management.md): Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps.
+- [Architecture](./docs/architecture.md): AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions.
+- [Configuration](./docs/configuration.md): This guide covers environment variables and configuration options for AppKit applications.
+- [Core principles](./docs/core-principles.md): Learn about the fundamental concepts and principles behind AppKit.
+- [Development](./docs/development.md): AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.
+- [Plugins](./docs/plugins.md): Plugins are modular extensions that add capabilities to your AppKit application. They follow a defined lifecycle and have access to shared services like caching, telemetry, and streaming.
+
+## Development
+
+- [AI-Assisted development](./docs/development/ai-assisted-development.md): AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.
+- [LLM Guide](./docs/development/llm-guide.md): This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.
+- [Local development](./docs/development/local-development.md): Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.
+- [Project setup](./docs/development/project-setup.md): This guide covers the recommended project structure and scaffolding for AppKit applications.
+- [Remote Bridge](./docs/development/remote-bridge.md): Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.
+- [Type generation](./docs/development/type-generation.md): AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.
+
+## Plugins
+
+- [Analytics plugin](./docs/plugins/analytics.md): Enables SQL query execution against Databricks SQL Warehouses.
+- [Caching](./docs/plugins/caching.md): AppKit provides both global and plugin-level caching capabilities.
+- [Creating custom plugins](./docs/plugins/custom-plugins.md): If you need custom API routes or background logic, implement an AppKit plugin. The fastest way is to use the CLI:
+- [Execution context](./docs/plugins/execution-context.md): AppKit manages Databricks authentication via two contexts:
+- [Lakebase plugin](./docs/plugins/lakebase.md): Currently, the Lakebase plugin currently requires a one-time manual setup to connect your Databricks App with your Lakebase database. An automated setup process is planned for an upcoming future release.
+- [Plugin management](./docs/plugins/plugin-management.md): AppKit includes a CLI for managing plugins. All commands are available under npx @databricks/appkit plugin.
+- [Server plugin](./docs/plugins/server.md): Provides HTTP server capabilities with development and production modes.
+
+## appkit API reference [collapsed]
+
+- [@databricks/appkit](./docs/api/appkit.md): Core library for building Databricks applications with type-safe SQL queries,
+- [Abstract Class: AppKitError](./docs/api/appkit/Class.AppKitError.md): Base error class for all AppKit errors.
+- [Class: AuthenticationError](./docs/api/appkit/Class.AuthenticationError.md): Error thrown when authentication fails.
+- [Class: ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md): Error thrown when configuration is missing or invalid.
+- [Class: ConnectionError](./docs/api/appkit/Class.ConnectionError.md): Error thrown when a connection or network operation fails.
+- [Class: ExecutionError](./docs/api/appkit/Class.ExecutionError.md): Error thrown when an operation execution fails.
+- [Class: InitializationError](./docs/api/appkit/Class.InitializationError.md): Error thrown when a service or component is not properly initialized.
+- [Abstract Class: Plugin<TConfig>](./docs/api/appkit/Class.Plugin.md): Base abstract class for creating AppKit plugins.
+- [Class: ResourceRegistry](./docs/api/appkit/Class.ResourceRegistry.md): Central registry for tracking plugin resource requirements.
+- [Class: ServerError](./docs/api/appkit/Class.ServerError.md): Error thrown when server lifecycle operations fail.
+- [Class: TunnelError](./docs/api/appkit/Class.TunnelError.md): Error thrown when remote tunnel operations fail.
+- [Class: ValidationError](./docs/api/appkit/Class.ValidationError.md): Error thrown when input validation fails.
+- [Enumeration: RequestedClaimsPermissionSet](./docs/api/appkit/Enumeration.RequestedClaimsPermissionSet.md): Permission set for Unity Catalog table access
+- [Enumeration: ResourceType](./docs/api/appkit/Enumeration.ResourceType.md): Resource types from schema $defs.resourceType.enum
+- [Function: appKitTypesPlugin()](./docs/api/appkit/Function.appKitTypesPlugin.md): Vite plugin to generate types for AppKit queries.
+- [Function: createApp()](./docs/api/appkit/Function.createApp.md): Bootstraps AppKit with the provided configuration.
+- [Function: createLakebasePool()](./docs/api/appkit/Function.createLakebasePool.md): Create a Lakebase pool with appkit's logger integration.
+- [Function: generateDatabaseCredential()](./docs/api/appkit/Function.generateDatabaseCredential.md): Generate OAuth credentials for Postgres database connection using the proper Postgres API.
+- [Function: getExecutionContext()](./docs/api/appkit/Function.getExecutionContext.md): Get the current execution context.
+- [Function: getLakebaseOrmConfig()](./docs/api/appkit/Function.getLakebaseOrmConfig.md): Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly.
+- [Function: getLakebasePgConfig()](./docs/api/appkit/Function.getLakebasePgConfig.md): Get Lakebase connection configuration for PostgreSQL clients.
+- [Function: getPluginManifest()](./docs/api/appkit/Function.getPluginManifest.md): Loads and validates the manifest from a plugin constructor.
+- [Function: getResourceRequirements()](./docs/api/appkit/Function.getResourceRequirements.md): Gets the resource requirements from a plugin's manifest.
+- [Function: getUsernameWithApiLookup()](./docs/api/appkit/Function.getUsernameWithApiLookup.md): Resolves the PostgreSQL username for a Lakebase connection.
+- [Function: getWorkspaceClient()](./docs/api/appkit/Function.getWorkspaceClient.md): Get workspace client from config or SDK default auth chain
+- [Function: isSQLTypeMarker()](./docs/api/appkit/Function.isSQLTypeMarker.md): Type guard to check if a value is a SQL type marker
+- [Interface: BasePluginConfig](./docs/api/appkit/Interface.BasePluginConfig.md): Base configuration interface for AppKit plugins
+- [Interface: CacheConfig](./docs/api/appkit/Interface.CacheConfig.md): Configuration for caching
+- [Interface: DatabaseCredential](./docs/api/appkit/Interface.DatabaseCredential.md): Database credentials with OAuth token for Postgres connection
+- [Interface: GenerateDatabaseCredentialRequest](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md): Request parameters for generating database OAuth credentials
+- [Interface: ITelemetry](./docs/api/appkit/Interface.ITelemetry.md): Plugin-facing interface for OpenTelemetry instrumentation.
+- [Interface: LakebasePoolConfig](./docs/api/appkit/Interface.LakebasePoolConfig.md): Configuration for creating a Lakebase connection pool
+- [Interface: PluginManifest](./docs/api/appkit/Interface.PluginManifest.md): Plugin manifest that declares metadata and resource requirements.
+- [Interface: RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md): Optional claims for fine-grained Unity Catalog table permissions
+- [Interface: RequestedResource](./docs/api/appkit/Interface.RequestedResource.md): Resource to request permissions for in Unity Catalog
+- [Interface: ResourceEntry](./docs/api/appkit/Interface.ResourceEntry.md): Internal representation of a resource in the registry.
+- [Interface: ResourceFieldEntry](./docs/api/appkit/Interface.ResourceFieldEntry.md): Defines a single field for a resource. Each field has its own environment variable and optional description.
+- [Interface: ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md): Declares a resource requirement for a plugin.
+- [Interface: StreamExecutionSettings](./docs/api/appkit/Interface.StreamExecutionSettings.md): Configuration for streaming execution with default and user-scoped settings
+- [Interface: TelemetryConfig](./docs/api/appkit/Interface.TelemetryConfig.md): OpenTelemetry configuration for AppKit applications
+- [Interface: ValidationResult](./docs/api/appkit/Interface.ValidationResult.md): Result of validating all registered resources against the environment.
+- [Type Alias: ConfigSchema](./docs/api/appkit/TypeAlias.ConfigSchema.md): Configuration schema definition for plugin config.
+- [Type Alias: IAppRouter](./docs/api/appkit/TypeAlias.IAppRouter.md): Express router type for plugin route registration
+- [Type Alias: ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
+- [Type Alias: ToPlugin()<T, U, N>](./docs/api/appkit/TypeAlias.ToPlugin.md): Type Parameters
+- [Variable: sql](./docs/api/appkit/Variable.sql.md): SQL helper namespace
+
+## appkit-ui API reference [collapsed]
+
+- [@databricks/appkit-ui](./docs/api/appkit-ui.md): The library provides a set of UI primitives for building Databricks apps in React.
+- [AreaChart](./docs/api/appkit-ui/data/AreaChart.md): Area Chart component for trend visualization with filled areas.
+- [BarChart](./docs/api/appkit-ui/data/BarChart.md): Bar Chart component for categorical comparisons.
+- [DataTable](./docs/api/appkit-ui/data/DataTable.md): Production-ready data table with automatic data fetching and state management
+- [DonutChart](./docs/api/appkit-ui/data/DonutChart.md): Donut Chart component (Pie chart with inner radius).
+- [HeatmapChart](./docs/api/appkit-ui/data/HeatmapChart.md): Heatmap Chart component for matrix-style data visualization.
+- [LineChart](./docs/api/appkit-ui/data/LineChart.md): Line Chart component for time-series and trend visualization.
+- [PieChart](./docs/api/appkit-ui/data/PieChart.md): Pie Chart component for proportional data visualization.
+- [RadarChart](./docs/api/appkit-ui/data/RadarChart.md): Radar Chart component for multi-dimensional data comparison.
+- [ScatterChart](./docs/api/appkit-ui/data/ScatterChart.md): Scatter Chart component for correlation and distribution visualization.
+- [GenieChat](./docs/api/appkit-ui/genie/GenieChat.md): Full-featured chat interface for a single Databricks AI/BI Genie space. Handles message streaming, conversation history, and auto-reconnection via SSE.
+- [GenieChatInput](./docs/api/appkit-ui/genie/GenieChatInput.md): Auto-expanding textarea input with a send button for chat messages. Submits on Enter (Shift+Enter for newline).
+- [GenieChatMessage](./docs/api/appkit-ui/genie/GenieChatMessage.md): Renders a single Genie message bubble with optional expandable SQL query attachments.
+- [GenieChatMessageList](./docs/api/appkit-ui/genie/GenieChatMessageList.md): Scrollable message list that renders Genie chat messages with auto-scroll, skeleton loaders, and a streaming indicator.
+- [Styling](./docs/api/appkit-ui/styling.md): This guide covers how to style AppKit UI components using CSS variables and theming.
+- [Accordion](./docs/api/appkit-ui/ui/Accordion.md): Collapsible content sections organized in a vertical stack
+- [Alert](./docs/api/appkit-ui/ui/Alert.md): Displays important information with optional icon and multiple variants
+- [AlertDialog](./docs/api/appkit-ui/ui/AlertDialog.md): Modal dialog that interrupts the user with critical information requiring immediate action
+- [AspectRatio](./docs/api/appkit-ui/ui/AspectRatio.md): Container that maintains a specific aspect ratio for its content
+- [Avatar](./docs/api/appkit-ui/ui/Avatar.md): Displays user profile picture or initials in a circular container
+- [Badge](./docs/api/appkit-ui/ui/Badge.md): Small label for displaying status, categories, or counts
+- [Breadcrumb](./docs/api/appkit-ui/ui/Breadcrumb.md): Navigation component showing the current page's location in the site hierarchy
+- [Button](./docs/api/appkit-ui/ui/Button.md): Clickable button with multiple variants and sizes
+- [ButtonGroup](./docs/api/appkit-ui/ui/ButtonGroup.md): Container for grouping related buttons together with shared borders
+- [Calendar](./docs/api/appkit-ui/ui/Calendar.md): Date picker component for selecting single dates or date ranges
+- [Card](./docs/api/appkit-ui/ui/Card.md): Container for grouping related content with header, body, and footer sections
+- [Carousel](./docs/api/appkit-ui/ui/Carousel.md): Slideshow component for cycling through content with navigation controls
+- [ChartContainer](./docs/api/appkit-ui/ui/ChartContainer.md): Container for rendering data visualizations using Recharts
+- [Checkbox](./docs/api/appkit-ui/ui/Checkbox.md): Checkbox input for selecting multiple options
+- [Collapsible](./docs/api/appkit-ui/ui/Collapsible.md): Interactive component that expands and collapses content
+- [Command](./docs/api/appkit-ui/ui/Command.md): Command palette for keyboard-driven navigation and actions
+- [ContextMenu](./docs/api/appkit-ui/ui/ContextMenu.md): Menu triggered by right-clicking an element
+- [Dialog](./docs/api/appkit-ui/ui/Dialog.md): Modal dialog that overlays the page content
+- [Drawer](./docs/api/appkit-ui/ui/Drawer.md): Draggable panel that slides in from screen edges
+- [DropdownMenu](./docs/api/appkit-ui/ui/DropdownMenu.md): Menu that displays when triggered by a button or element
+- [Empty](./docs/api/appkit-ui/ui/Empty.md): Empty state component for displaying no-data scenarios
+- [Field](./docs/api/appkit-ui/ui/Field.md): Form field wrapper with label and input positioning
+- [FormControl](./docs/api/appkit-ui/ui/FormControl.md): Wrapper for form control elements with accessibility attributes
+- [HoverCard](./docs/api/appkit-ui/ui/HoverCard.md): Content card that appears when hovering over an element
+- [Input](./docs/api/appkit-ui/ui/Input.md): Text input field for single-line user input
+- [InputGroup](./docs/api/appkit-ui/ui/InputGroup.md): Container for combining input fields with addons and buttons
+- [InputOTP](./docs/api/appkit-ui/ui/InputOTP.md): One-time password input with individual character slots
+- [Item](./docs/api/appkit-ui/ui/Item.md): Flexible container for list items with media, content, and actions
+- [Kbd](./docs/api/appkit-ui/ui/Kbd.md): Visual representation of keyboard keys
+- [Label](./docs/api/appkit-ui/ui/Label.md): Text label associated with form controls
+- [Menubar](./docs/api/appkit-ui/ui/Menubar.md): Horizontal menu bar with dropdown menus
+- [NavigationMenu](./docs/api/appkit-ui/ui/NavigationMenu.md): Horizontal navigation menu with dropdown submenus
+- [Pagination](./docs/api/appkit-ui/ui/Pagination.md): Navigation component for paginated content
+- [Popover](./docs/api/appkit-ui/ui/Popover.md): Floating content panel anchored to a trigger element
+- [Progress](./docs/api/appkit-ui/ui/Progress.md): Visual indicator showing task completion percentage
+- [RadioGroup](./docs/api/appkit-ui/ui/RadioGroup.md): Group of radio buttons for selecting a single option
+- [ResizableHandle](./docs/api/appkit-ui/ui/ResizableHandle.md): Draggable handle for resizing panels
+- [ScrollArea](./docs/api/appkit-ui/ui/ScrollArea.md): Container with custom scrollbars for overflow content
+- [Select](./docs/api/appkit-ui/ui/Select.md): Dropdown control for selecting a value from a list
+- [Separator](./docs/api/appkit-ui/ui/Separator.md): Visual divider line between content sections
+- [Sheet](./docs/api/appkit-ui/ui/Sheet.md): Sliding panel that overlays content from screen edges
+- [Sidebar](./docs/api/appkit-ui/ui/Sidebar.md): Collapsible navigation sidebar with mobile support
+- [Skeleton](./docs/api/appkit-ui/ui/Skeleton.md): Loading placeholder with pulsing animation
+- [Slider](./docs/api/appkit-ui/ui/Slider.md): Draggable input for selecting numeric values within a range
+- [Spinner](./docs/api/appkit-ui/ui/Spinner.md): Animated loading indicator
+- [Switch](./docs/api/appkit-ui/ui/Switch.md): Toggle control for switching between on and off states
+- [Table](./docs/api/appkit-ui/ui/Table.md): Structured data display with rows and columns
+- [Tabs](./docs/api/appkit-ui/ui/Tabs.md): Tabbed interface for organizing content into separate panels
+- [Textarea](./docs/api/appkit-ui/ui/Textarea.md): Multi-line text input field
+- [Toaster](./docs/api/appkit-ui/ui/Toaster.md): Toast notification system for displaying temporary messages
+- [Toggle](./docs/api/appkit-ui/ui/Toggle.md): Button that toggles between pressed and unpressed states
+- [ToggleGroup](./docs/api/appkit-ui/ui/ToggleGroup.md): Group of toggle buttons for selecting one or more options
+- [Tooltip](./docs/api/appkit-ui/ui/Tooltip.md): Brief informational message that appears on hover

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@databricks/appkit-ui",
   "type": "module",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/databricks/appkit.git"
@@ -12,6 +12,7 @@
     "bin",
     "scripts",
     "docs",
+    "docs.md",
     "CLAUDE.md",
     "llms.txt",
     "README.md",