From b7d092c25b00da9b405e29f8c3b86d3f1aba5b41 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Fri, 14 Aug 2026 22:52:10 +0000 Subject: [PATCH] document generated reference docs Co-Authored-By: brandon --- AGENTS.md | 6 ++++-- README.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 84bece7..e5a29e0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -29,5 +29,7 @@ ## Content boundaries -{/* Define what should and shouldn't be documented */} -{/* Example: Don't document internal admin features */} +- Reference docs are generated from the `ravionhq/flightcontrol` monorepo and must never be hand-edited. +- Generated paths include `cli/reference/*.mdx`, `cli/overview.mdx`, schema-reference snippets, `module-definitions/definition-schema/` pages, and generated module catalog pages. +- Change the source in `flightcontrol` and regenerate using the README's **Regenerating reference docs** instructions. +- CLI page `description` frontmatter comes from the `seoDescriptions` map in `packages/cli/internal/cmdgen/mintlify-docs/main.go`. diff --git a/README.md b/README.md index d2a900e..aa2b6a7 100644 --- a/README.md +++ b/README.md @@ -75,8 +75,8 @@ pnpm sync:cli-reference Every page's `og:image`/`twitter:image` frontmatter points at the Ravion OG renderer (`https://www.ravion.com/og/docs/.png`), which draws the same banner used for the marketing site and the blog and reads the page title from the page's Mintlify -Markdown export. Generated pages do not carry those tags, so after regenerating any -reference docs run: +Markdown export. The CLI generator emits those tags itself. After regenerating schema +reference or module catalog pages, run: ```bash pnpm sync:og-images