Skip to content

Commit bdf3806

Browse files
authored
Fix docs links (#17)
## Changes <!-- Summary of your changes that are easy to understand. Add screenshots when necessary --> This PR fixes broken documentation hyperlinks and makes some minor changes to the docs. ### Linked issues <!-- DOC: Link issue with a keyword: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved. See https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword --> N/A ### Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [x] manually tested - [ ] added unit tests - [ ] added integration tests
1 parent bcdbe82 commit bdf3806

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/content/docs/guide.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import { Callout } from 'fumadocs-ui/components/callout';
88
import { Steps, Step } from 'fumadocs-ui/components/steps';
99

1010
This guide walks through an end-to-end conversion of an Azure Data Factory pipeline to Lakeflow Jobs. You will install the
11-
flowx skills in your agentic tool, hand it a directory of Azure Data Factory JSON exports, and end up with a Databricks
12-
Asset Bundle you can deploy.
11+
flowx skills in your agentic tool, hand it a directory of pipeline templates for conversion, and create a Declarative Automation
12+
Bundle you can use to deploy a Databricks Lakeflow Job.
1313

1414
<Steps>
1515
<Step>

docs/content/docs/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: What flowx is and where to start.
66
## Motivation
77

88
flowx was created to automate migrations of data pipelines between various orchestrators. It provides a robust, tested set of capabilities
9-
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/).
9+
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/).
1010

1111
## How flowx works
1212

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

2828
## Next steps
2929

30-
- **[Architecture](/flowx/docs/architecture)** &mdash; understand how flowx is deployed and how it translates
31-
- **[Installation](/flowx/docs/installation)** &mdash; install the flowx plugin in your agentic tool of choice.
32-
- **[Usage Guide](/flowx/docs/guide)** &mdash; run an end-to-end conversion from raw ADF JSON to a deployable bundle.
33-
- **[Configuration](/flowx/docs/configuration)** &mdash; reference documenting options for customizing output when translating pipelines with flowx.
30+
- **[Architecture](/docs/architecture)** &mdash; understand how flowx is deployed and how it translates
31+
- **[Installation](/docs/installation)** &mdash; install the flowx plugin in your agentic tool of choice.
32+
- **[Usage Guide](/docs/guide)** &mdash; run an end-to-end conversion from raw ADF JSON to a deployable bundle.
33+
- **[Configuration](/docs/configuration)** &mdash; reference documenting options for customizing output when translating pipelines with flowx.

docs/content/docs/installation.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ user or for all users within a workspace.
4343
To add flowx skills for a single user, copy the skills from the flowx folder to your `.assistant` folder:
4444

4545
```bash
46-
databricks workspace <FLOWX_DIRECTORY> skills /Users/<EMAIL_ADDRESS>/.assistant/skills
46+
databricks workspace import-dir skills /Users/<EMAIL_ADDRESS>/.assistant/skills
4747
```
4848
</Tab>
4949

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

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

111111
## Installing flowx for Claude Code
112112

113-
flowx can also be installed with local agent harnesses (e.g. Claude Code) as an agent skills plugin. Skills can from a Python
114-
virtual environment or locally-hosted MCP server.
113+
flowx can also be installed with local agent harnesses (e.g. Claude Code) as an agent skills plugin. Skills can run commands
114+
from a Python virtual environment or locally-hosted MCP server.
115115

116116
<Steps>
117117
<Step>
@@ -157,11 +157,11 @@ The environment is created once and reused. No `uv` is required for plugin users
157157
### Verify
158158

159159
Open Claude Code and ask *"What flowx skills do you have available?"*. You should see a list of skills (e.g. `flowx-setup`,
160-
`flowx-migrate`). You can now run `/flowx:flowx-migrate`, `/flowx:flowx-discover`, and other flows skills.
160+
`flowx-migrate`). You can now run `/flowx:flowx-migrate`, `/flowx:flowx-discover`, and other flowx skills.
161161

162162
<Callout type="warn" title="Troubleshooting missing dependencies">
163163
If calling a skill raises a `ModuleNotFoundError`, the virtual environment is missing or incomplete. Ensure Python is installed
164-
in your environment and that you have access to a Python package registry for installing depenedencies, then re-run `/flowx:flowx-setup`.
164+
in your environment and that you have access to a Python package registry for installing dependencies, then re-run `/flowx:flowx-setup`.
165165
</Callout>
166166
</Step>
167167
</Steps>

0 commit comments

Comments
 (0)