From a9d4b4775efcbbfb270a51c801ab58eef55e43a3 Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Tue, 13 Jan 2026 09:20:51 +0100 Subject: [PATCH 1/3] docs: add announcement bar about AppKit not being ready --- docs/docusaurus.config.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 3eba122..20f161a 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -134,6 +134,14 @@ const config: Config = { ], themeConfig: { + announcementBar: { + id: "preview-not-for-production", + content: + "⚠️ AppKit is in an early development phase and is subject to change without notice. DO NOT use in production environments.", + backgroundColor: "#f0f0f0", + textColor: "#000000", + isCloseable: true, + }, colorMode: { respectPrefersColorScheme: true, }, From 13653cd2cd7869045de6ea2e99174cf82d59aa78 Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Tue, 13 Jan 2026 09:21:12 +0100 Subject: [PATCH 2/3] docs: update Readme to point to the latest documentation --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 36 +++++++++++++++++++++--------------- 2 files changed, 36 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e902b2..ea17a66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,3 +84,18 @@ export DATABRICKS_PROFILE=your-profile # Databricks profile name. Used as a Data export DATABRICKS_APP_NAME=your-app-name # The name of the app to deploy. If not provided, it will be prefixed with the username. export DATABRICKS_WORKSPACE_DIR=your-workspace-dir # The source workspace directory to deploy the app from. It will be used to construct the absolute path: /Workspace/Users/{your-username}/{workspace-dir} ``` + +## Contributing to AppKit documentation + +The `docs/` directory contains the AppKit documentation site, built with Docusaurus. + +**Working with docs:** + +```bash +# From root +pnpm docs:dev # Start dev server +pnpm docs:build # Build docs +pnpm docs:serve # Serve built docs +``` + +See [docs/README.md](./docs/README.md) for more details. diff --git a/README.md b/README.md index aed3028..155c48c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # AppKit -> [!WARNING] -> ## ⚠️ PREVIEW - NOT FOR PRODUCTION USE +Build Databricks Apps faster with brand-new Node.js + React SDK. Built for humans and AI. + +> [!WARNING] PREVIEW - NOT FOR PRODUCTION USE > > **This SDK is in preview and is subject to change without notice.** > @@ -11,25 +12,30 @@ > - 📝 **Use for development and testing only** > -## Contributing +## Introduction -See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines. +AppKit is a TypeScript SDK for building production-ready Databricks applications with a plugin-based architecture. It provides opinionated defaults, built-in observability, and seamless integration with Databricks services. -## Documentation +AppKit simplifies building data applications on Databricks by providing: + +- **Plugin architecture**: Modular design with built-in server and analytics plugins +- **Type safety**: End-to-end TypeScript with automatic query type generation +- **Production-ready features**: Built-in caching, telemetry, retry logic, and error handling +- **Developer experience**: Remote hot reload, file-based queries, optimized for AI-assisted development +- **Databricks native**: Seamless integration with SQL Warehouses, Unity Catalog, and other workspace resources -The `docs/` directory contains the AppKit documentation site, built with Docusaurus. +## Getting started -**Working with docs:** +Follow the [Getting Started](https://databricks.github.io/appkit/docs/) guide to get started with AppKit. -```bash -# From root -pnpm docs:dev # Start dev server -pnpm docs:build # Build docs -pnpm docs:serve # Serve built docs -``` +## Documentation -See [docs/README.md](./docs/README.md) for more details. +📖 For full AppKit documentation, visit the [AppKit Documentation](https://databricks.github.io/appkit/) website. 👉 For AI/code assistants: - Use [llms-compact.txt](./llms-compact.txt) for quick usage patterns. -- See [llms.txt](./llms.txt) for full guidance and anti-patterns. \ No newline at end of file +- See [llms.txt](./llms.txt) for full guidance and anti-patterns. + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines. From 602e0c1dee3396266578d921d59b7d44122f0967 Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Tue, 13 Jan 2026 17:39:08 +0100 Subject: [PATCH 3/3] chore: update announcement message --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 155c48c..b7f7d13 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # AppKit -Build Databricks Apps faster with brand-new Node.js + React SDK. Built for humans and AI. +Build Databricks Apps faster with our brand-new Node.js + React SDK. Built for humans and AI. > [!WARNING] PREVIEW - NOT FOR PRODUCTION USE >