Skip to content

Fix docs links #17

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
ghanse merged 3 commits into from
Aug 18, 2026
Merged

Fix docs links #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0cb37fe
Update flowx documentation
ghanse Aug 18, 2026
22cc5f7
Fix docs hyperlinks
ghanse Aug 18, 2026
4116393
Merge branch 'main' into fix-docs-links
ghanse Aug 18, 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
4 changes: 2 additions & 2 deletions docs/content/docs/guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Steps>
<Step>
Expand Down
10 changes: 5 additions & 5 deletions docs/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -27,7 +27,7 @@ All three phases write into one shared output directory (default `./flowx_output

## Next steps

- **[Architecture](/flowx/docs/architecture)** &mdash; understand how flowx is deployed and how it translates
- **[Installation](/flowx/docs/installation)** &mdash; install the flowx plugin in your agentic tool of choice.
- **[Usage Guide](/flowx/docs/guide)** &mdash; run an end-to-end conversion from raw ADF JSON to a deployable bundle.
- **[Configuration](/flowx/docs/configuration)** &mdash; reference documenting options for customizing output when translating pipelines with flowx.
- **[Architecture](/docs/architecture)** &mdash; understand how flowx is deployed and how it translates
- **[Installation](/docs/installation)** &mdash; install the flowx plugin in your agentic tool of choice.
- **[Usage Guide](/docs/guide)** &mdash; run an end-to-end conversion from raw ADF JSON to a deployable bundle.
- **[Configuration](/docs/configuration)** &mdash; reference documenting options for customizing output when translating pipelines with flowx.
12 changes: 6 additions & 6 deletions docs/content/docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <FLOWX_DIRECTORY> skills /Users/<EMAIL_ADDRESS>/.assistant/skills
databricks workspace import-dir skills /Users/<EMAIL_ADDRESS>/.assistant/skills
```
</Tab>

Expand Down Expand Up @@ -102,16 +102,16 @@ Ask Genie Code *"What flowx MCP tools are available?"*. You should see the singl
and other flowx skills.

<Callout type="info" title="Troubleshooting the flowx MCP app">
If Genie Code does not have access to the flowx MCP tool, open the your app's health endpoint at `<APP URL>/`. This should
If Genie Code does not have access to the flowx MCP tool, open your app's health endpoint at `<APP URL>/`. This should
return `{"status":"ok"}`). If you cannot access the health endpoint, verify the deployment steps and redeploy the app.
</Callout>
</Step>
</Steps>

## 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.

<Steps>
<Step>
Expand Down Expand Up @@ -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.

<Callout type="warn" title="Troubleshooting missing dependencies">
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`.
</Callout>
</Step>
</Steps>
Expand Down