scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-10-10 03:30:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

fix(docs): use MDX comment syntax for generated fences

Browse source 
Mintlify parses pages as MDX and rejects HTML-style `<!-- ... -->`
comments, which broke the docs deployment on cli.mdx with a parse
error. Switch the generator fences (and the matching markers in the
two reference pages and the dev test fixtures) to `{/* ... */}` so
Mintlify can parse them.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Bryan Helmkamp 2026-04-29 01:27:43 -04:00
parent f676fa779b
commit 24b8f1ec04
No known key found for this signature in database
5 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/public/reference/cli.mdx
View file

@ -52,7 +52,7 @@ Explicit `http(s)://...` targets are always treated as remote servers. They do n
CLI flags always override `settings.toml` values, which override hardcoded defaults.
<!-- generated:cli -->
{/* generated:cli */}
## `fabro`
```bash
@ -1334,4 +1334,4 @@ List available workflows
```bash
fabro workflow list [OPTIONS]
```
<!-- /generated:cli -->
{/* /generated:cli */}

4
docs/public/reference/user-configuration.mdx
View file

@ -112,7 +112,7 @@ Authorization = "Bearer sk-xxx"
All fields are optional. Include only the sections and keys you want to override. A single file can still include both CLI and server sections when you run both processes on one machine, but explicit remote targets do not read remote server state from the local machine.
<!-- generated:options -->
{/* generated:options */}
## `[cli.target]`
Connection info for commands that target a remote Fabro server.
@ -293,4 +293,4 @@ tool_timeout = "90s"
| `tool_timeout` | duration | `"60s"` | Max duration for a single MCP tool call. |
See [MCP](/agents/mcp) for transport-specific examples.
<!-- /generated:options -->
{/* /generated:options */}

4
lib/crates/fabro-dev/src/commands/docs_cli_reference.rs
View file

@ -7,8 +7,8 @@ use clap::{Arg, ArgAction, Command};
use super::{markdown_cell, replace_generated_region};
const CLI_REFERENCE_PATH: &str = "docs/public/reference/cli.mdx";
const FENCE_START: &str = "<!-- generated:cli -->";
const FENCE_END: &str = "<!-- /generated:cli -->";
const FENCE_START: &str = "{/* generated:cli */}";
const FENCE_END: &str = "{/* /generated:cli */}";
#[expect(
clippy::print_stdout,

4
lib/crates/fabro-dev/src/commands/docs_options_reference.rs
View file

@ -7,8 +7,8 @@ use fabro_options_metadata::{OptionField, OptionSet};
use super::{markdown_cell, replace_generated_region};
const OPTIONS_REFERENCE_PATH: &str = "docs/public/reference/user-configuration.mdx";
const FENCE_START: &str = "<!-- generated:options -->";
const FENCE_END: &str = "<!-- /generated:options -->";
const FENCE_START: &str = "{/* generated:options */}";
const FENCE_END: &str = "{/* /generated:options */}";
#[expect(
clippy::print_stdout,

8
lib/crates/fabro-dev/tests/it/docs.rs
View file

@ -24,9 +24,9 @@ title: CLI
Intro copy.
<!-- generated:cli -->
{/* generated:cli */}
stale cli
<!-- /generated:cli -->
{/* /generated:cli */}
Tail copy.
",
@ -40,9 +40,9 @@ title: Settings
Settings intro copy.
<!-- generated:options -->
{/* generated:options */}
stale options
<!-- /generated:options -->
{/* /generated:options */}
Settings tail copy.
",