[docs] Remove the commit step from the agent guides - #6489
Conversation
The agent configuration auto-commits (#6126): there is no Commit button in the Configuration header, and agents have no Registry page in the sidebar. The guides still walked users through Commit > New version as a required step. Replaces those instructions with the auto-save behaviour, removes the now-empty commit sections from the automation, harness and subscription guides, and points version history at the vN chip in the agent header instead of Registry. Also corrects the trigger Version field, which defaults to the latest revision rather than pinning one.
The trigger and schedule drawers' Version field lets an automation follow the agent's newest version or stay on one you choose. The docs described it as pin-only, and built the automations concept page on a draft-versus-committed review point that auto-commit removed. Rewrites the 'Which version runs?' step in both guides and reframes the concept section around the choice, without documenting the picker's internals.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📘 Docs preview
Pages changed in this pull request
This comment updates in place on every push. |
📝 SummarySummary by CodeRabbit
WalkthroughThe documentation removes manual agent commit steps, describes direct configuration saves, and updates automation version guidance. ChangesAgent versioning documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: 🟡 Moderate · up to The guides now omit required commit and pinned-version steps for unattended automations, which can lead users to configure workflows with unclear authorization and execution-revision behavior; another save workflow still does not consistently explain when changes take effect. These documentation errors should be corrected before merging. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The guides explained how the configuration persists itself: a state dot, a version per save, a grant landing in the next version. That is internal behaviour, and it dates the copy to one implementation. Says what the reader gets instead. Click Save or Create, and the change applies.
ashrafchowdury
changed the title
Which version a schedule or trigger runs is not a decision the reader makes while filling in the form, so the step was noise between the cadence and the message. Removes it from both guides, renumbers the step that followed, and takes version out of the schedule guide's description.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Team
Run ID: 0e46c662-1a9d-484a-bbcf-4b318853c1e0
📒 Files selected for processing (5)
docs/docs/concepts/01-agents.mdxdocs/docs/guides/01-write-your-agents-instructions.mdxdocs/docs/guides/03-manage-skills.mdxdocs/docs/guides/04-add-an-mcp-server.mdxdocs/docs/guides/06-create-an-automation.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/docs/concepts/01-agents.mdx
- docs/docs/guides/01-write-your-agents-instructions.mdx
- docs/docs/guides/03-manage-skills.mdx
Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.
The trigger guides no longer walk through the Version field, so the overview sentence and the concept section explaining the choice had nothing left to point at. Drops the Version clause from the create-an-automation overview and removes the 'Each automation runs a version you choose' section.
There was a problem hiding this comment.
Actionable comments posted: 2
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Team
Run ID: 626d5c8c-5771-449f-8618-de1cbec99ea1
📒 Files selected for processing (4)
docs/docs/concepts/07-automations.mdxdocs/docs/guides/06-create-an-automation.mdxdocs/docs/guides/07-schedule-an-automation.mdxdocs/docs/guides/08-trigger-an-automation-from-an-app.mdx
💤 Files with no reviewable changes (1)
- docs/docs/concepts/07-automations.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/docs/guides/07-schedule-an-automation.mdx
Included review availability: Your plan provides up to 8 included reviews per hour; 5 remain after this review.
2 participants
Context
Nine docs pages walked readers through a
Commit>New versionstep that no longer exists. The agent playground has noCommitbutton in its Configuration header, and agents have no Registry page in the sidebar, so one guide also sent readers somewhere they cannot go.The trigger and schedule guides carried a related problem. Both spent a numbered step on which version an automation runs, and the automations concept page devoted a section to the same choice.
Changes
The commit step is gone. Where a step was only "click Commit", it is removed. Where a step did real work, the commit clause is dropped from it.
Before:
After:
The trailing
## Commitsections in the harness and subscription guides are removed outright, along with## Commit before you schedule,## Commit before you subscribe, and## Commit a version.Version selection is gone from the automation pages. The
### 3. Which version runs?step is removed from both trigger guides and the step that followed is renumbered, the overview sentence in the create guide drops itsVersionclause, and the concept page loses its "Each automation runs a version you choose" section. Picking a version is not a decision the reader makes while filling in the form.Persistence mechanics are out too. An intermediate draft explained how the configuration saves itself, naming a status indicator and describing when a change becomes a version. Readers do not need that, so the guides now say what they get: click
SaveorCreate, and the change applies.Notes
Every claim was checked against
origin/release/v0.114.5rather than the local working tree. That mattered: GitButler had an unmerged branch applied locally that adds an agent version-history drawer, and an early draft of these docs described it. It is not on the release branch.Verified on the release branch:
autoSave, andAgentConfigHeaderrenders no commit button under it.workflowCategories: ["app"], so agents never show it.No
What to QAsection. Nothing here is user-visible beyond the docs site.