Skip to content

docs(setup): document the existing validate+init stale-relay resync path - #802

Open
gmoncor wants to merge 1 commit into
bmad-code-org:mainfrom
gmoncor:docs/s01-03-document-resync-hook-relay
Open

gmoncor wants to merge 1 commit into
bmad-code-org:mainfrom
gmoncor:docs/s01-03-document-resync-hook-relay

Conversation

@gmoncor

@gmoncor gmoncor commented Sep 17, 2026

Copy link
Copy Markdown

What: Document that bmad-loop validate already flags a stale hook relay copy (via install.hook_script_current and the "hooks.relay-stale" warning) and that bmad-loop init is the existing resync command for it.

Why: A stray docstring implies no detect+resync mechanism exists for the hook relay, but validate and init already provide it together; the real gap is discoverability, not a missing feature, so no new command should be added. Related to #563, which shows the resync is not fully reliable when a stale marker already exists (re-init can print "hooks already registered" without updating a command-shape change) -- this PR documents the happy path and links #563 as its known limitation, rather than overstating the mechanism as unconditionally reliable.

How:

  • Add a short note to docs/setup-guide.md and AGENTS.md near the existing hooks/relay documentation, cross-referencing bmad-loop validate's stale-relay warning and bmad-loop init as its fix.

Testing: Read-through diff; doc-only change, no new command implemented.

Changelog: "Docs: documented that bmad-loop validate detects a stale hook relay and bmad-loop init resyncs it."

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 169f6df1-3315-43a6-8c47-4a8cf4eadd0f

📥 Commits

Reviewing files that changed from the base of the PR and between e10f02f and ec1808f.

📒 Files selected for processing (3)
  • AGENTS.md
  • CHANGELOG.md
  • docs/setup-guide.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gmoncor
gmoncor marked this pull request as ready for review September 17, 2026 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant