docs: update mcp__brc__propose for push-first behavior [doc-updater] - #2008
Conversation
There was a problem hiding this comment.
Doc-only change, single line in docs/reference/agent-tools.md. Verified against the implementation.
Accuracy check — all claims confirmed:
- Push-first behavior:
brc_proposeinsandbox/egg_agent_tools/tools/brc.py:184-205does callconsensus_push()beforehandlers.brc_propose(). Correct. pushparameter defaults totrue: Schema attools/brc.py:56-66has"default": True, andbrc_proposepops it withinbound.pop("push", True). Correct.- Push failure short-circuits: The handler raises
HandlerErroron non-zero return code, preventing proposal dispatch. Correct. - CLI counterpart
egg-orch consensus propose --push: Matchesdocs/reference/orchestrator-cli.md:319. Correct.
No issues found. The old description ("Broadcast a proposal with summary, artifacts, files-changed, tests-run, tasks, and commit SHA") was stale after #2002 added push-first behavior — this update brings the doc in line with the code.
One minor suggestion (non-blocking): The new Purpose cell is quite long for a markdown table row. Consider moving the push parameter details to a footnote or a dedicated subsection below the table to improve readability. Not worth blocking on.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Agreed. Moved the — Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Re-review of new commit 7715d007 (addressing previous feedback).
Previous feedback: addressed
The suggestion to move push details out of the table cell into a subsection was implemented correctly. The table is now readable and the subsection is well-written.
Issue found in new commit
Blocking: Broken anchor link — {#brc-propose-push-behavior} syntax not supported by GitHub
File: docs/reference/agent-tools.md:114
The new heading uses Pandoc-style explicit anchor syntax:
#### `brc_propose` push behavior {#brc-propose-push-behavior}This repo's docs are rendered on GitHub, which uses GFM (GitHub Flavored Markdown). GFM does not support {#id} attribute syntax. Two problems result:
{#brc-propose-push-behavior}renders as literal visible text in the heading on GitHub — ugly and confusing.- The in-table link
[push behavior](#brc-propose-push-behavior)is dead. GitHub's auto-generated slug for the heading (including the literal{...}text) would be#brc_propose-push-behavior-brc-propose-push-behavior— which doesn't match the link target.
This is the only instance of {#...} syntax anywhere in docs/. No other doc file uses it.
Fix: Remove the explicit anchor. GitHub auto-generates anchors from heading text. The heading:
#### `brc_propose` push behaviorproduces the auto-slug #brc_propose-push-behavior (underscore preserved). Update the in-table link to match:
See [push behavior](#brc_propose-push-behavior) below.— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Remove Pandoc-style {#id} anchor syntax (not supported by GitHub
Flavored Markdown) and update the in-table link to use GitHub's
auto-generated slug.
There was a problem hiding this comment.
Agreed. Removed the Pandoc-style {#brc-propose-push-behavior} anchor syntax from the heading and updated the in-table link to use GitHub's auto-generated slug (#brc_propose-push-behavior, underscore preserved from the backtick-code in the heading text).
— Authored by egg
There was a problem hiding this comment.
Re-review of commit ed3c3b0 (fixing GFM anchor link).
Previous feedback: addressed
The Pandoc-style {#brc-propose-push-behavior} anchor syntax has been removed from the heading at line 114. The in-table link at line 103 has been updated from #brc-propose-push-behavior to #brc_propose-push-behavior, correctly matching GitHub's auto-generated slug (the underscore in brc_propose is preserved through GFM's slugification).
Verified:
- No stale references to the old
#brc-propose-push-behavioranchor remain anywhere indocs/. - The heading text
`brc_propose` push behaviorproduces the GFM slugbrc_propose-push-behavior— link matches. - Doc content still accurately reflects the implementation in
sandbox/egg_agent_tools/tools/brc.py(push-first default, short-circuit on failure, CLI counterpart).
No issues found.
— Authored by egg
|
egg review completed. View run logs 5 previous review(s) hidden. |
…2008) * docs: update mcp__brc__propose description and CLI counterpart * docs: move brc_propose push details to subsection for readability * docs: fix GFM anchor link for brc_propose push behavior section Remove Pandoc-style {#id} anchor syntax (not supported by GitHub Flavored Markdown) and update the in-table link to use GitHub's auto-generated slug. --------- Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com> Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com> Auto-Filtered: true
…2008) * docs: update mcp__brc__propose description and CLI counterpart * docs: move brc_propose push details to subsection for readability * docs: fix GFM anchor link for brc_propose push behavior section Remove Pandoc-style {#id} anchor syntax (not supported by GitHub Flavored Markdown) and update the in-table link to use GitHub's auto-generated slug. --------- Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com> Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com> Auto-Filtered: true
…2008) * docs: update mcp__brc__propose description and CLI counterpart * docs: move brc_propose push details to subsection for readability * docs: fix GFM anchor link for brc_propose push behavior section Remove Pandoc-style {#id} anchor syntax (not supported by GitHub Flavored Markdown) and update the in-table link to use GitHub's auto-generated slug. --------- Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com> Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com>
…2008) * docs: update mcp__brc__propose description and CLI counterpart * docs: move brc_propose push details to subsection for readability * docs: fix GFM anchor link for brc_propose push behavior section Remove Pandoc-style {#id} anchor syntax (not supported by GitHub Flavored Markdown) and update the in-table link to use GitHub's auto-generated slug. --------- Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com> Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com>
docs: update mcp__brc__propose for push-first behavior [doc-updater]
Update
docs/reference/agent-tools.mdto reflect changes from b38ddd8(#2002):
mcp__brc__proposenow pushes committed changes to origin via thegateway before broadcasting CONSENSUS_PROPOSE. The new
pushparameter(default
true) can be set tofalseto skip the push.egg-orch consensus proposetoegg-orch consensus propose --pushto match the equivalent flag.Other docs already reflected the new behavior:
docs/guides/concurrent-execution.md(lines 487–504) already describesthe
egg_agent_tools.push.consensus_push()delegation.docs/architecture/git-isolation.mdalready documents the pushrequirement for concurrent mode.
docs/reference/orchestrator-cli.mdalready shows the--pushflag.Triggered by: #2002
Issue: none
Test Plan
mcp__brc__proposeindocs/reference/agent-tools.mdis accurate againstsandbox/egg_agent_tools/tools/brc.pyAuthored-by: egg