docs(acp): add a Subscription Scope section to the configuration reference - #5710
Open
EmminiX wants to merge 1 commit into
Open
docs(acp): add a Subscription Scope section to the configuration reference#5710EmminiX wants to merge 1 commit into
EmminiX wants to merge 1 commit into
Conversation
…rence BUZZ_ACP_SUBSCRIBE, BUZZ_ACP_CHANNELS, BUZZ_ACP_KINDS, BUZZ_ACP_NO_MENTION_FILTER and BUZZ_ACP_CONTEXT_MESSAGE_LIMIT are real flags in config.rs, and none of these env var names appear anywhere in this README. The Configuration section documents every other group of flags in a table; these five had no entry. The Forum Channels section does use --no-mention-filter and explains what it enables (forum posts stop being invisible). It does not say what its scope is, which is the part that bites: the harness subscribes to every channel the identity belongs to, and the membership notification subscription adds more over time, so in mentions mode the flag applies across all of them at once. The new callout says that and points at the two things that bound it, --channels and the author gate. Defaults and behaviour checked against config.rs: resolve_channel_filters (require_mention = !no_mention_filter per channel) and resolve_dynamic_channel_filter (channels_override filters discovery rather than replacing it, and is ignored in config mode). Signed-off-by: Emanuel Covasa <e.covasa@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
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
Adds a "Subscription Scope" section to the buzz-acp configuration reference, covering five flags
that had no entry there:
BUZZ_ACP_SUBSCRIBE,BUZZ_ACP_CHANNELS,BUZZ_ACP_KINDS,BUZZ_ACP_NO_MENTION_FILTERandBUZZ_ACP_CONTEXT_MESSAGE_LIMIT. None of those env var namesappear anywhere in the README today, while every other group of flags has a table.
It sits after the Inbound Author Gate on purpose: that section decides whose events arrive,
this one decides which channels are watched and what opens a turn.
The Forum Channels section already uses
--no-mention-filterand explains what it enables, so thisis not introducing the flag. What is missing there is its scope, which is the part that bites:
the harness subscribes to every channel the identity belongs to and the membership notification
subscription adds more over time, so in
mentionsmode the flag applies across all of them atonce. With several agents in one workspace and the author gate widened, one message can open a turn
on several agents.
The callout says that and points at the two things that bound it,
--channelsand the author gate.I lost a day to this, which is why it seemed worth writing down.
Duplicate search
No open PR documents these flags. #4922 touches
BUZZ_ACP_NO_MENTION_FILTERbut is a code fix forboolean parsing rather than documentation. Five open PRs touch this file; none edits the
configuration tables.
Testing
Documentation only, no code paths changed. Every flag name, default and behaviour statement was
checked against
crates/buzz-acp/src/config.rs, specificallyresolve_channel_filters(
require_mention = !no_mention_filter, applied per channel) andresolve_dynamic_channel_filter(
channels_overridefilters discovery rather than replacing it, and is ignored inconfigmode).Rebased on current
main.Logging
No logging changes.