Skip to content

docs: generate ravion.yaml with project create --file instead of hand-writing it - #52

Merged
flybayer merged 2 commits into
mainfrom
devin/1786660868-project-create-file
Aug 14, 2026
Merged

docs: generate ravion.yaml with project create --file instead of hand-writing it#52
flybayer merged 2 commits into
mainfrom
devin/1786660868-project-create-file

Conversation

@devin-ai-integration

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

Copy link
Copy Markdown
Contributor

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.yaml loses 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.yaml for a new project, project config pull --file ravion.yaml for an existing one), the page consistently uses ravion.yaml instead of project.yaml, and the Agent tips section opens with the rule to never hand-write the file from memory.

cli/reference/project.mdx is regenerated for the new --file flag (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.yaml directly instead of asking users or agents to hand-write it.

  • Documents project create --file in the generated CLI reference.
  • Provides separate generation commands for new and existing projects.
  • Uses ravion.yaml consistently throughout the workflow.
  • Adds agent guidance to preserve generated headers, comments, and links.

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

Filename Overview
cli/reference/project.mdx Adds the new optional --file flag to the ravion project create reference.
config-as-code/project-config-file.mdx Revises project setup to generate 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

devin-ai-integration Bot and others added 2 commits August 13, 2026 22:50
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
@flybayer flybayer self-assigned this Aug 13, 2026
@mintlify

mintlify Bot commented Aug 13, 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 13, 2026, 10:52 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

@flybayer
flybayer merged commit aca94e2 into main Aug 14, 2026
6 checks passed
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