Document that reference docs are generated from the monorepo - #55
Closed
devin-ai-integration[bot] wants to merge 1 commit into
Closed
Document that reference docs are generated from the monorepo#55devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| {/* 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. |
There was a problem hiding this 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.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 theog:image/twitter:imagefrontmatter 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 theseoDescriptionsmap as the source of CLI page descriptions.README.md: the CLI generator now emits the social-share tags itself (ravionhq/flightcontrol#6941), sopnpm sync:og-imagesis 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 --checkpasses.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.
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
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "document generated reference docs" | Re-trigger Greptile