Skip to content

Commit d339e91

Browse files
authored
chore: update docs and template (#62)
1 parent 3e6368d commit d339e91

7 files changed

Lines changed: 7 additions & 37 deletions

File tree

docs/docs/app-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Manage your AppKit application throughout its lifecycle using the Databricks CLI
1212

1313
## Create app
1414

15-
See the [Quick start](./index.md#quick-start-options) section to create a new Databricks app with AppKit installed.
15+
See the [Quick start](./index.md) section to create a new Databricks app with AppKit installed.
1616

1717
## Configuration
1818

File renamed without changes.

docs/docs/development/_prerequisites_app.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
- [Node.js](https://nodejs.org) environment
44
- Databricks CLI: install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
5-
- A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](../index.md#quick-start-options) for more details.
5+
- A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](../index.md) for more details.

docs/docs/development/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ AppKit provides multiple development workflows to suit different needs: local de
1515
There are multiple supported development flows available with AppKit:
1616

1717
1. **[Local development](./local-development.mdx)**: 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.
18-
2. **[AI-assisted development](./ai-assisted-development.mdx)**: Use an AI coding assistant connected via the Databricks MCP server to explore data, run CLI commands, and scaffold your app interactively.
19-
3. **[Remote Bridge](./remote-bridge.mdx)**: 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.
18+
1. **[Remote Bridge](./remote-bridge.mdx)**: 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.
2019

2120
## See also
2221

docs/docs/development/local-development.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Prerequisites from './_prerequisites_app.mdx';
88

99
<Prerequisites />
1010

11-
Once your app is bootstrapped according to the [Manual quick start](../index.md#manual-quick-start) guide, you can start the development server with hot reload for both UI and backend code.
11+
Once your app is bootstrapped according to the [Manual quick start](../index.md) guide, you can start the development server with hot reload for both UI and backend code.
1212

1313
In the application root directory, run the following command to start the development server:
1414

docs/docs/index.md

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,36 +20,7 @@ AppKit simplifies building data applications on Databricks by providing:
2020

2121
<Prerequisites />
2222

23-
## Quick start options
24-
25-
There are two ways to get started with AppKit:
26-
27-
- **AI-assisted** (recommended): Use an AI coding assistant connected via the Databricks MCP server to explore data, run CLI commands, and scaffold your app interactively.
28-
- **Manual**: Use the Databricks CLI directly to create, bootstrap, and deploy your app.
29-
30-
Choose the path that best fits your workflow; both approaches produce the same kind of AppKit-based Databricks application.
31-
32-
## AI-first quick start
33-
34-
Databricks AppKit is designed to work with AI coding assistants through the Databricks MCP server.
35-
36-
Install the Databricks MCP server and configure it for use with your preferred AI assistant:
37-
38-
```bash
39-
databricks experimental apps-mcp install
40-
```
41-
42-
Once configured for your development environment, you can use your AI assistant to create and deploy new Databricks applications, as well as to iteratively evolve your app's codebase.
43-
44-
Just prompt your AI assistant to create a new Databricks app, such as:
45-
46-
```
47-
Create a new Databricks app that displays a dashboard of the nyc taxi trips dataset.
48-
```
49-
50-
To learn more about the MCP server, see the [AI-assisted development](./development/ai-assisted-development.mdx) documentation.
51-
52-
## Manual quick start
23+
## Quick start
5324

5425
Learn how to create and deploy a sample Databricks application that uses AppKit with the Databricks CLI.
5526

template/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
"license": "Unlicensed",
2929
"description": "{{.app_description}}",
3030
"dependencies": {
31-
"@databricks/appkit": "0.2.0",
32-
"@databricks/appkit-ui": "0.2.0",
31+
"@databricks/appkit": "0.3.0",
32+
"@databricks/appkit-ui": "0.3.0",
3333
"@databricks/sdk-experimental": "^0.14.2",
3434
"clsx": "^2.1.1",
3535
"embla-carousel-react": "^8.6.0",

0 commit comments

Comments
 (0)