docs(acp): correct Codex quick-start, idle timeout, and author gate - #5187
Open
Diego-F-Aguirre wants to merge 1 commit into
Open
docs(acp): correct Codex quick-start, idle timeout, and author gate#5187Diego-F-Aguirre wants to merge 1 commit into
Diego-F-Aguirre wants to merge 1 commit into
Conversation
Three README statements disagree with the code they describe. The Codex quick-start never sets BUZZ_ACP_AGENT_COMMAND, so following it verbatim spawns goose rather than codex-acp: the flag defaults to "goose" (config.rs). The Claude Code section already sets it, so this also removes an internal inconsistency between the two runtime sections. BUZZ_ACP_IDLE_TIMEOUT is documented as 620, but DEFAULT_IDLE_TIMEOUT_SECS is 900 (config.rs), asserted by a unit test in the same file. The author-gate section documents four modes and notes the owner is implicitly included, but omits two behaviors that materially change who can prompt an agent. owner-only and allowlist also accept same-owner siblings, verified from the author's NIP-OA auth tag (is_owner_or_sibling in lib.rs). Inside a DM, anyone and allowlist do not apply at all — only the owner and verified siblings may fire a turn, and unknown channel type is treated as a DM. Both are already described in the author_allowed doc comment; this surfaces them in the README. Docs only; no behavior change. Signed-off-by: Diego-F-Aguirre <diego3884@gmail.com>
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
1 participant
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
Three statements in
crates/buzz-acp/README.mddisagree with the code they describe. Docs only, no behavior change.1. The Codex quick-start silently spawns goose. The "Running with Codex" block never sets
BUZZ_ACP_AGENT_COMMAND, which defaults to"goose"(config.rs). Following it verbatim installscodex-acpand then runs goose. The Claude Code section already sets the variable, so this also removes an inconsistency between the two runtime sections.2.
BUZZ_ACP_IDLE_TIMEOUTis documented as620.DEFAULT_IDLE_TIMEOUT_SECSis900(config.rs), asserted by a unit test in the same file.3. The author-gate section omits two behaviors that change who can prompt an agent. The table documents four modes and notes the owner is implicitly included, but does not mention that:
owner-onlyandallowlistalso accept same-owner siblings, verified from the author's NIP-OA auth tag (is_owner_or_sibling);anyoneandallowlistdo not apply at all — only the owner and verified siblings may fire a turn, and unknown channel type is treated as a DM.Both are already documented in the
author_alloweddoc comment; this surfaces them where operators configure the gate. The DM behavior in particular is a deliberate hardening against transitive access grants, and an operator reading only the README could reasonably conclude--respond-to allowlistis authoritative in DMs.Related issue
None found. Searched open issues and PRs for these specifics. The closest related PR is #5168, which also touches DM handling in this crate, but changes the mention subscription filter rather than the author gate — no overlap with these lines.
Testing
Documentation only; no code paths changed and no tests affected. Each correction was checked against the source at the commit this branch is based on rather than inferred from the docs.