From 24b8f1ec045b691d31d6e336d838e8f95aea2cb0 Mon Sep 17 00:00:00 2001 From: Bryan Helmkamp Date: Wed, 29 Apr 2026 01:27:43 -0400 Subject: [PATCH] fix(docs): use MDX comment syntax for generated fences 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) --- docs/public/reference/cli.mdx | 4 ++-- docs/public/reference/user-configuration.mdx | 4 ++-- lib/crates/fabro-dev/src/commands/docs_cli_reference.rs | 4 ++-- .../fabro-dev/src/commands/docs_options_reference.rs | 4 ++-- lib/crates/fabro-dev/tests/it/docs.rs | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/public/reference/cli.mdx b/docs/public/reference/cli.mdx index 299cbbdc7..aa290b8ba 100644 --- a/docs/public/reference/cli.mdx +++ b/docs/public/reference/cli.mdx @@ -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 */} ## `fabro` ```bash @@ -1334,4 +1334,4 @@ List available workflows ```bash fabro workflow list [OPTIONS] ``` - +{/* /generated:cli */} diff --git a/docs/public/reference/user-configuration.mdx b/docs/public/reference/user-configuration.mdx index eb0578052..6e977c141 100644 --- a/docs/public/reference/user-configuration.mdx +++ b/docs/public/reference/user-configuration.mdx @@ -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 */} ## `[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 */} diff --git a/lib/crates/fabro-dev/src/commands/docs_cli_reference.rs b/lib/crates/fabro-dev/src/commands/docs_cli_reference.rs index 6004cd021..433fdb55b 100644 --- a/lib/crates/fabro-dev/src/commands/docs_cli_reference.rs +++ b/lib/crates/fabro-dev/src/commands/docs_cli_reference.rs @@ -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 = ""; -const FENCE_END: &str = ""; +const FENCE_START: &str = "{/* generated:cli */}"; +const FENCE_END: &str = "{/* /generated:cli */}"; #[expect( clippy::print_stdout, diff --git a/lib/crates/fabro-dev/src/commands/docs_options_reference.rs b/lib/crates/fabro-dev/src/commands/docs_options_reference.rs index 750a98823..361ec5e2e 100644 --- a/lib/crates/fabro-dev/src/commands/docs_options_reference.rs +++ b/lib/crates/fabro-dev/src/commands/docs_options_reference.rs @@ -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 = ""; -const FENCE_END: &str = ""; +const FENCE_START: &str = "{/* generated:options */}"; +const FENCE_END: &str = "{/* /generated:options */}"; #[expect( clippy::print_stdout, diff --git a/lib/crates/fabro-dev/tests/it/docs.rs b/lib/crates/fabro-dev/tests/it/docs.rs index 6e8aa9060..e61ade3ae 100644 --- a/lib/crates/fabro-dev/tests/it/docs.rs +++ b/lib/crates/fabro-dev/tests/it/docs.rs @@ -24,9 +24,9 @@ title: CLI Intro copy. - +{/* generated:cli */} stale cli - +{/* /generated:cli */} Tail copy. ", @@ -40,9 +40,9 @@ title: Settings Settings intro copy. - +{/* generated:options */} stale options - +{/* /generated:options */} Settings tail copy. ",