docs: lead with wait --watch instead of polling get - #48
Conversation
Co-Authored-By: brandon <brandon@flightcontrol.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
🤖 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:
|
| curl -fsSL https://github.com/ravionhq/cli/releases/latest/download/install.sh | sh | ||
| ``` | ||
|
|
||
| On macOS, install with Homebrew: | ||
|
|
||
| ```bash | ||
| brew install flightcontrolhq/tap/ravion | ||
| brew install ravionhq/tap/ravion |
There was a problem hiding this comment.
Installation organizations are inconsistent
These commands use ravionhq, while the linked Installation page and getting-started guide still use flightcontrolhq for the same release repository and Homebrew tap, leaving readers with conflicting canonical installation commands.
Prompt To Fix With AI
This is a comment left during a code review.
Path: cli/overview.mdx
Line: 18-24
Comment:
**Installation organizations are inconsistent**
These commands use `ravionhq`, while the linked Installation page and getting-started guide still use `flightcontrolhq` for the same release repository and Homebrew tap, leaving readers with conflicting canonical installation commands.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
flybayer
left a comment
There was a problem hiding this comment.
the cli reference files are generated from main repo and need updated there
… on CLI release) Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
|
Right — dropped |
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Summary
Agent feedback: following
config-as-code/project-config-file.mdxliterally led an agent to pollravion pipeline run getin a loop, because the docs never mentionedpipeline run wait --watch. This rewrites the run-review guidance so waiting is the documented default, and adds the agent rule that would have changed that behavior:Changed pages:
config-as-code/project-config-file.mdx— review step now leads withwait --watch --timeout 30m, thenget-plan/get-apply; separate manual-approval flow (--until PENDING_APPROVAL→get-plan→approve→wait); new agent rule plus a "don't poll in a loop" entry.modules/stack.mdx,modules/build.mdx,migrate/import-into-*.mdx— same wait-first ordering where they previously showedgetpolling.modules/deploy.mdx— documents the newravion deploy wait <deployment-id> --watch, which did not exist before (the deploy namespace had no wait equivalent, so agents fell back todeploy getpolling).cli/reference/*andcli/overview.mdxare regenerated from the CLI source bymake docsinpackages/cli(companion PR inflightcontrol): newravion deploy waitpage section, examples/long help forpipeline run wait/get/get-plan/get-apply, and theflightcontrolhq→ravionhqinstall URLs that had drifted from the generator. og:image frontmatter was re-synced withpnpm sync:og-images.Link to Devin session: https://app.devin.ai/sessions/daa0ed23475843dca66cf50223f6387f
Requested by: @flybayer
Greptile Summary
The PR replaces polling guidance with
wait --watch, documents the new deployment wait command, and updates generated CLI installation links. The primary config-review example waits for completion before a manually gated run can be inspected and approved, and the new installation organization conflicts with other canonical installation pages.Confidence Score: 4/5
The documentation should not merge until the default manual-approval workflow is reordered so users can inspect and approve the plan before waiting for completion.
The documented config apply defaults to a manually gated run, but the primary review sequence waits for terminal completion first and therefore stalls at PENDING_APPROVAL until timeout; the installation organization is also inconsistent across linked pages.
Files Needing Attention: config-as-code/project-config-file.mdx, modules/stack.mdx, cli/overview.mdx
Important Files Changed
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: lead with wait --watch workflows f..." | Re-trigger Greptile