Skip to content

Document that reference docs are generated from the monorepo - #55

Closed
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786747912-cli-docs-generated-notes
Closed

Document that reference docs are generated from the monorepo#55
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786747912-cli-docs-generated-notes

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #53. The CLI reference pages are generated from ravionhq/flightcontrol, but nothing in this repo told an agent that, so the previous PR's regeneration silently stripped the og:image/twitter:image frontmatter before it was noticed.

  • AGENTS.md: the placeholder "Content boundaries" section now lists the generated paths (cli/reference/*.mdx, cli/overview.mdx, schema-reference snippets, module-definitions/definition-schema/, generated catalog pages), says to change the source in flightcontrol and regenerate per the README, and points at the seoDescriptions map as the source of CLI page descriptions.
  • README.md: the CLI generator now emits the social-share tags itself (ravionhq/flightcontrol#6941), so pnpm sync:og-images is only needed after the schema-reference and module-catalog generators.

No page content changes: regenerating with the updated generator produces output byte-identical to what's committed, and node scripts/sync-og-images.mjs --check passes.

Link to Devin session: https://app.devin.ai/sessions/9f22d1560a7344029cbf1702e004338e
Requested by: @flybayer

Greptile Summary

The PR documents which reference content is generated and narrows the social-image synchronization instructions now that the CLI generator emits those tags.

  • Replaces the placeholder content-boundary section with generated-path and source guidance.
  • Updates post-generation social-image instructions for CLI, schema, and module catalog documentation.
  • The new boundary points module catalog contributors to a README workflow that does not document catalog regeneration.

Confidence Score: 4/5

The PR appears safe to merge, with a non-blocking documentation gap for regenerating module catalog pages.

The generated-content boundary is useful, but contributors cannot follow its referenced README workflow for module catalog updates because that regeneration process is not documented there.

Files Needing Attention: AGENTS.md, README.md

Important Files Changed

Filename Overview
AGENTS.md Adds generated-content boundaries, but the module catalog is directed to regeneration instructions that do not cover it.
README.md Narrows social-image synchronization guidance to schema and module catalog output based on the updated CLI generator behavior.
Prompt To Fix All With AI
### Issue 1
AGENTS.md:34
**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.

Reviews (1): Last reviewed commit: "document generated reference docs" | Re-trigger Greptile

Greptile also left 1 inline comment on this PR.

Co-Authored-By: brandon <brandon@flightcontrol.dev>
@flybayer flybayer self-assigned this Aug 14, 2026
@mintlify

mintlify Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Ravion 🟢 Ready View Preview Aug 14, 2026, 10:53 PM

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

Comment thread AGENTS.md
{/* 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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant