diff --git a/docs/content/docs/guide.mdx b/docs/content/docs/guide.mdx index 2572aa5..ef17e20 100644 --- a/docs/content/docs/guide.mdx +++ b/docs/content/docs/guide.mdx @@ -8,8 +8,8 @@ import { Callout } from 'fumadocs-ui/components/callout'; import { Steps, Step } from 'fumadocs-ui/components/steps'; This guide walks through an end-to-end conversion of an Azure Data Factory pipeline to Lakeflow Jobs. You will install the -flowx skills in your agentic tool, hand it a directory of Azure Data Factory JSON exports, and end up with a Databricks -Asset Bundle you can deploy. +flowx skills in your agentic tool, hand it a directory of pipeline templates for conversion, and create a Declarative Automation +Bundle you can use to deploy a Databricks Lakeflow Job. diff --git a/docs/content/docs/index.mdx b/docs/content/docs/index.mdx index ad294e8..533a109 100644 --- a/docs/content/docs/index.mdx +++ b/docs/content/docs/index.mdx @@ -6,7 +6,7 @@ description: What flowx is and where to start. ## Motivation flowx was created to automate migrations of data pipelines between various orchestrators. It provides a robust, tested set of capabilities -to parse existing data pipeline definitions, create migration artifacts, and convert data pipeline definitions to Databricks' [Lakeflow jobs framework](https://docs.databricks.com/aws/en/jobs/). +to parse existing data pipeline definitions, create migration artifacts, and convert data pipeline definitions to [Databricks Lakeflow Jobs](https://docs.databricks.com/aws/en/jobs/). ## How flowx works @@ -27,7 +27,7 @@ All three phases write into one shared output directory (default `./flowx_output ## Next steps -- **[Architecture](/flowx/docs/architecture)** — understand how flowx is deployed and how it translates -- **[Installation](/flowx/docs/installation)** — install the flowx plugin in your agentic tool of choice. -- **[Usage Guide](/flowx/docs/guide)** — run an end-to-end conversion from raw ADF JSON to a deployable bundle. -- **[Configuration](/flowx/docs/configuration)** — reference documenting options for customizing output when translating pipelines with flowx. +- **[Architecture](/docs/architecture)** — understand how flowx is deployed and how it translates +- **[Installation](/docs/installation)** — install the flowx plugin in your agentic tool of choice. +- **[Usage Guide](/docs/guide)** — run an end-to-end conversion from raw ADF JSON to a deployable bundle. +- **[Configuration](/docs/configuration)** — reference documenting options for customizing output when translating pipelines with flowx. diff --git a/docs/content/docs/installation.mdx b/docs/content/docs/installation.mdx index 9b7ec77..1d2fb83 100644 --- a/docs/content/docs/installation.mdx +++ b/docs/content/docs/installation.mdx @@ -43,7 +43,7 @@ user or for all users within a workspace. To add flowx skills for a single user, copy the skills from the flowx folder to your `.assistant` folder: ```bash -databricks workspace skills /Users//.assistant/skills +databricks workspace import-dir skills /Users//.assistant/skills ``` @@ -102,7 +102,7 @@ Ask Genie Code *"What flowx MCP tools are available?"*. You should see the singl and other flowx skills. -If Genie Code does not have access to the flowx MCP tool, open the your app's health endpoint at `/`. This should +If Genie Code does not have access to the flowx MCP tool, open your app's health endpoint at `/`. This should return `{"status":"ok"}`). If you cannot access the health endpoint, verify the deployment steps and redeploy the app. @@ -110,8 +110,8 @@ return `{"status":"ok"}`). If you cannot access the health endpoint, verify the ## Installing flowx for Claude Code -flowx can also be installed with local agent harnesses (e.g. Claude Code) as an agent skills plugin. Skills can from a Python -virtual environment or locally-hosted MCP server. +flowx can also be installed with local agent harnesses (e.g. Claude Code) as an agent skills plugin. Skills can run commands +from a Python virtual environment or locally-hosted MCP server. @@ -157,11 +157,11 @@ The environment is created once and reused. No `uv` is required for plugin users ### Verify Open Claude Code and ask *"What flowx skills do you have available?"*. You should see a list of skills (e.g. `flowx-setup`, -`flowx-migrate`). You can now run `/flowx:flowx-migrate`, `/flowx:flowx-discover`, and other flows skills. +`flowx-migrate`). You can now run `/flowx:flowx-migrate`, `/flowx:flowx-discover`, and other flowx skills. If calling a skill raises a `ModuleNotFoundError`, the virtual environment is missing or incomplete. Ensure Python is installed -in your environment and that you have access to a Python package registry for installing depenedencies, then re-run `/flowx:flowx-setup`. +in your environment and that you have access to a Python package registry for installing dependencies, then re-run `/flowx:flowx-setup`.