Skip to content

Document that reference docs are generated from the monorepo #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
devin-ai-integration wants to merge 1 commit into from
Closed

Document that reference docs are generated from the monorepo #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

@greptile-apps greptile-apps Bot Aug 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Module catalog workflow is missing

The new boundary directs contributors updating generated module catalog pages to the README's regeneration instructions, but that section documents only schema and CLI generation. This leaves contributors without the actual catalog regeneration workflow and encourages hand-editing output that the catalog sync can overwrite.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: AGENTS.md
Line: 34

Comment:
**Module catalog workflow is missing**

The new boundary directs contributors updating generated module catalog pages to the README's regeneration instructions, but that section documents only schema and CLI generation. This leaves contributors without the actual catalog regeneration workflow and encourages hand-editing output that the catalog sync can overwrite.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

- CLI page `description` frontmatter comes from the `seoDescriptions` map in `packages/cli/internal/cmdgen/mintlify-docs/main.go`.
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<page-path>.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
Expand Down
Loading