docs: generate ravion.yaml with project create --file instead of hand-writing it - #52
Merged
Merged
Conversation
Co-Authored-By: brandon <brandon@flightcontrol.dev>
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:
|
flybayer
approved these changes
Aug 14, 2026
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
The config-as-code page told you to create a project and then pull its config as two separate steps, so nothing pointed an agent at a generated starting file — hand-writing
ravion.yamlloses the AI skill header, inline input comments, and app links.The create/pull steps are now one step with both entry points (
project create --given-id ... --file ravion.yamlfor a new project,project config pull --file ravion.yamlfor an existing one), the page consistently usesravion.yamlinstead ofproject.yaml, and the Agent tips section opens with the rule to never hand-write the file from memory.cli/reference/project.mdxis regenerated for the new--fileflag (one row).Requires the CLI change: https://github.com/ravionhq/flightcontrol/pull/6935
Link to Devin session: https://app.devin.ai/sessions/20585abf2d96498dbb3b6529cf834ed4
Requested by: @flybayer
Greptile Summary
Updates the config-as-code workflow to generate
ravion.yamldirectly instead of asking users or agents to hand-write it.project create --filein the generated CLI reference.ravion.yamlconsistently throughout the workflow.Confidence Score: 5/5
The documentation changes appear safe to merge alongside the explicitly required CLI change.
The revised commands and filenames are internally consistent, preserve both new-project and existing-project workflows, and introduce no concrete unacknowledged failure.
Important Files Changed
--fileflag to theravion project createreference.ravion.yaml, uses that filename consistently, and warns agents not to recreate it manually.Reviews (1): Last reviewed commit: "Keep canonical module definition list co..." | Re-trigger Greptile