Fix docs links - #17
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation site to fix broken internal links and improve docs rendering (notably code blocks), alongside some minor docs content and styling updates.
Changes:
- Add a global MDX components override to wrap fenced code blocks and enable language-class rendering.
- Update docs navigation and internal links (e.g., “Options” → “Configuration”) and refresh docs wording in several pages.
- Switch the docs UI theme CSS and bump a couple of Python build constraint pins.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/source.config.ts | Enables rehype code options so language classes are available for code rendering. |
| docs/mdx-components.tsx | Adds global MDX component overrides (code blocks, tabs). |
| docs/content/docs/meta.json | Updates docs nav ordering/slug from options to configuration. |
| docs/content/docs/installation.mdx | Rewords and restructures installation instructions for Genie Code and local harnesses. |
| docs/content/docs/index.mdx | Fixes internal doc links and updates introductory wording. |
| docs/content/docs/guide.mdx | Rewords the end-to-end guide and updates examples/callouts. |
| docs/content/docs/configuration.mdx | Renames the page and adds translation report documentation. |
| docs/app/global.css | Switches fumadocs UI theme stylesheet. |
| docs/app/docs/[[...slug]]/page.tsx | Wires global MDX components into page rendering. |
| .build-constraints.txt | Updates pinned build constraints (hatchling/packaging) and adds tomlkit pin. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <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. |
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 fixes broken documentation hyperlinks and makes some minor changes to the docs.
Linked issues
N/A
Tests