[luv-343] docs: document per-CLI Stop semantics + Pi limitation#342
[luv-343] docs: document per-CLI Stop semantics + Pi limitation#342NiveditJain merged 2 commits intomainfrom
Conversation
Follow-up to #341: explain to end-users how `require-*-before-stop` behaves across the 7 supported CLIs, with a dedicated note for Pi. Adds a "Per-CLI Stop semantics" subsection to the Workflow chapter of docs/built-in-policies.mdx: - 7-row table covering Claude / Codex / Copilot / Cursor / Gemini / OpenCode / Pi, showing where the gate fires and what the user sees. - A `<Note>` callout walking through the Pi limitation: Pi's `AgentEndEvent` has no Result type, so failproofai shifts enforcement to `before_agent_start` (next user turn). Pi visibly stops between turns; the gate fires the moment you submit the next prompt. Bounds (Pi process lifetime, `session_shutdown` cleanup) are spelled out so users enabling Stop policies on Pi understand the behavior before filing a bug. Translated copies under docs/{ar,de,es,fr,he,hi,it,ja,ko,pt-br,ru,tr,vi,zh}/ will be regenerated by the translate-docs workflow on merge. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR adds a “Per-CLI Stop semantics” subsection to the Workflow docs describing how Stop enforcement behaves across seven CLIs (Claude Code, Codex, GitHub Copilot CLI, Cursor Agent, Gemini CLI, OpenCode, Pi) and records the change in CHANGELOG.md (0.0.10-beta.13). ChangesPer-CLI Stop Semantics Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CHANGELOG.md`:
- Line 6: Replace the placeholder "(`#PR`)" in the CHANGELOG.md entry that begins
"Per-CLI Stop semantics" with the actual pull request number (e.g. "(`#1234`)"),
ensuring the changelog line remains a single-line entry per project guidelines;
locate the string "(`#PR`)" in the CHANGELOG.md entry text and update it to the
real PR numeral so the release traceability format is preserved.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7912c1e1-0862-4d20-ba80-2237cde14633
📒 Files selected for processing (2)
CHANGELOG.mddocs/built-in-policies.mdx
Summary
Follow-up to #341. The Pi
Stop-policy fix landed but it's a behavior end-users will see (Pi visibly stops, then the gate fires on the next prompt) — that's worth documenting up-front so a user enablingrequire-commit-before-stopon Pi understands the experience before filing a bug.Adds a "Per-CLI Stop semantics" subsection at the top of the Workflow chapter in
docs/built-in-policies.mdx:<Note>callout for Pi covering: why force-retry isn't possible (Pi'sAgentEndEventhas no Result type — verified againstpi-mono/packages/coding-agent/src/core/extensions/types.ts:1112), how the next-turnbefore_agent_startinjection works, that the gate is one-shot per drain, and what the bounds are (Pi process lifetime;session_shutdownclears any pending entry for any reason).No code changes — pure docs PR.
Files
docs/built-in-policies.mdx— new "Per-CLI Stop semantics" subsection in the Workflow chapter (28 lines added).CHANGELOG.md—0.0.10-beta.13 — 2026-05-10Docs entry.Translated copies under
docs/{ar,de,es,fr,he,hi,it,ja,ko,pt-br,ru,tr,vi,zh}/built-in-policies.mdxwill be regenerated by thetranslate-docsworkflow when this lands onmain.Test plan
<Note>open/close tag balance: 6 / 6 (matches existing file).🤖 Generated with Claude Code
Summary by CodeRabbit