Update flowx documentation - #16
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the FlowX documentation site to improve readability, add richer code-block rendering (including language classes and a custom <pre> renderer), and refresh navigation/content across key docs pages.
Changes:
- Added a custom MDX component mapping to enhance code blocks (titles + typed/language-aware rendering) and enabled
rehypeCodedefaults in the MDX pipeline. - Updated docs IA/content: renamed “Options” to “Configuration”, refreshed Installation/Guide/Index content, and added a new “Translation report” section.
- Updated the docs site theme CSS and bumped a few Python build constraint pins.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source.config.ts | Enables rehype code defaults + language class injection for MDX code blocks. |
| docs/mdx-components.tsx | Adds custom MDX component mapping (code blocks + tabs integration). |
| docs/content/docs/meta.json | Updates sidebar/nav ordering to replace “options” with “configuration”. |
| docs/content/docs/installation.mdx | Rewrites installation instructions and adds tabbed install flows for Genie Code / Claude Code. |
| docs/content/docs/index.mdx | Refreshes introduction content and updates links to the new configuration page. |
| docs/content/docs/guide.mdx | Updates the end-to-end usage guide language and structure. |
| docs/content/docs/configuration.mdx | Renames page and adds translation report documentation. |
| docs/app/global.css | Switches docs theme CSS preset. |
| docs/app/docs/[[...slug]]/page.tsx | Passes the custom MDX component mapping into rendered MDX pages. |
| .build-constraints.txt | Updates pinned build-time Python dependencies/hashes. |
Suppressed comments (1)
docs/content/docs/installation.mdx:55
- This CLI example appears to be invalid:
databricks workspace <FLOWX_DIRECTORY> skills ...is missing theimport-dirsubcommand and likely won't work as written. Update it to a validdatabricks workspace import-dir ...form (including theskills/source path).
```bash
databricks workspace <FLOWX_DIRECTORY> skills /Workspace/.assistant/skills
</details>
---
💡 <a href="/databricks-solutions/flowx/new/main?filename=.github/skills/code-review/SKILL.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add a `code-review` agent skill</a> or configure MCP servers for context-aware, tailored reviews. <a href="https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review#mcp-servers-and-agent-skills" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn more in the docs.</a>
Comment on lines
+1
to
+10
| import { isValidElement } from 'react'; | ||
| import defaultComponents from 'fumadocs-ui/mdx'; | ||
| import type { MDXComponents } from 'mdx/types'; | ||
| import { CodeBlock, Pre } from 'fumadocs-ui/components/codeblock'; | ||
| import * as TabsComponents from 'fumadocs-ui/components/tabs'; | ||
|
|
||
| function getCodeLanguage(children: React.ReactNode): string | undefined { | ||
| if (!isValidElement<{ className?: string }>(children)) return undefined; | ||
| const match = children.props.className?.match(/language-([a-z0-9]+)/i); | ||
| return match?.[1]; |
|
|
||
| ```bash | ||
| databricks workspace import-dir skills /Users/<your-email>/.assistant/skills | ||
| databricks workspace <FLOWX_DIRECTORY> skills /Users/<EMAIL_ADDRESS>/.assistant/skills |
Comment on lines
+105
to
+106
| If Genie Code does not have access to the flowx MCP tool, open the 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. |
Comment on lines
+113
to
+114
| 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. |
Comment on lines
+159
to
+160
| 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. |
| ``` | ||
| <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`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR updates the flowx documentation to improve readability and update the installation, user guide, and configuration pages. It adds typed code blocks and modifies the site theme.
Linked issues
N/A
Tests