docs: README/STATUS refresh for coordination layer + prior pending commits - #197
Conversation
Fix picking an arbitrary/stale .worktrees dir; support matching by branch name (e.g. -Task master) or task worktree name (-Task 20).
…minal additionalContext silently reaches Claude's context but Claude Code never renders it to the user's screen. systemMessage is the field that does. Session-start output (pending items, coaching rules, setup reminders) was reaching the assistant but never actually showing up for the user.
… STATUS.md The README described agentflare as purely a token/cost optimization tool (lean-ctx, memory, Caveman, Ponytail). It has grown a second layer since: a local-first multi-agent coordination backend (work items, review, artifacts, handoff, coaching) exposed over MCP. Rewrite the intro and architecture tree to reflect both layers, and add an explicit Beta status banner + STATUS.md splitting what's stable from what's still changing. Also stop tracking docs/ (product-overview.md, business-overview.md, etc.) -- these were internal planning docs that ended up committed by accident. Moved to a new gitignored .docs/ directory; kept on disk, just untracked going forward. Existing git history is untouched (no rewrite/force-push).
📝 WalkthroughWalkthroughThe PR marks agentflare as Beta, documents its optimization and coordination layers, adds status guidance, removes legacy documentation, improves worktree-based installation selection, and changes session-start hooks to emit structured JSON. ChangesDocumentation and repository metadata
Worktree-aware installation
Structured session-start hook output
Estimated code review effort: 3 (Moderate) | ~30 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
scripts/refresh-install.ps1 (1)
9-50: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win
-Taskis silently ignored when already inside a worktree.The entire worktree-resolution/matching block is only entered when
.gitis a directory (i.e., running from the main repo root). If a caller runs the script from inside a linked worktree and passes-Task <other-worktree>, that block is skipped and the script silently installs from the current worktree instead of the one named by-Task— no warning or error is raised. Given this installs a system binary (cargo install --force), silently installing from the wrong worktree could be confusing.Consider at least warning when
-Taskis supplied but not applied because the script is already inside a worktree, or extending the matching logic to also apply when-Taskis set regardless of current location.♻️ Example: warn when `-Task` is ignored
+if ($Task -and -not (Test-Path (Join-Path $root ".git") -PathType Container)) { + Write-Warning "[refresh-install] Already inside a worktree ($root); ignoring -Task '$Task'." +} if (Test-Path (Join-Path $root ".git") -PathType Container) {🤖 Prompt for 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. In `@scripts/refresh-install.ps1` around lines 9 - 50, Ensure the -Task selection is handled whenever -Task is supplied, including when the script is launched from inside a linked worktree. Update the worktree-resolution logic around the $Task matching block so it either resolves the requested worktree regardless of the current location or explicitly warns and exits when -Task cannot be applied; never silently continue using the current worktree.
🤖 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.
Nitpick comments:
In `@scripts/refresh-install.ps1`:
- Around line 9-50: Ensure the -Task selection is handled whenever -Task is
supplied, including when the script is launched from inside a linked worktree.
Update the worktree-resolution logic around the $Task matching block so it
either resolves the requested worktree regardless of the current location or
explicitly warns and exits when -Task cannot be applied; never silently continue
using the current worktree.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 58525544-17f6-4203-9674-de089045ee6d
📒 Files selected for processing (15)
.gitignoreREADME.mdSTATUS.mddocs/api-sdk-reference.mddocs/architecture-system-design.mddocs/business-overview.mddocs/data-model.mddocs/deployment-and-operations.mddocs/feature-agent-lifecycle-cli.mddocs/feature-caam-auth-vault.mddocs/product-overview.mddocs/security.mddocs/testing.mdscripts/refresh-install.ps1src/hook.rs
💤 Files with no reviewable changes (10)
- docs/architecture-system-design.md
- docs/security.md
- docs/feature-agent-lifecycle-cli.md
- docs/deployment-and-operations.md
- docs/api-sdk-reference.md
- docs/testing.md
- docs/business-overview.md
- docs/data-model.md
- docs/product-overview.md
- docs/feature-caam-auth-vault.md
Summary
update.rs/install.sh(string-inequality version comparison, not semver).docs/(10 internal planning docs, ~5,175 lines) that were committed by accident; moved to a new gitignored.docs/dir, kept on disk, existing git history untouched.Test plan
.docs/is gitignored and does not appear in the diffSummary by CodeRabbit
Documentation
Improvements