Update README for current capabilities#47
Conversation
|
Warning Review limit reached
More reviews will be available in 6 minutes and 15 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. 📝 WalkthroughWalkthroughThis PR updates README and release metadata for v1.6.1 (new feature docs, config, examples, project structure, CI), expands coordination barrel exports to expose review-loop and interrupt APIs/types, and refactors consensus-service expiration tests for deterministic behavior. Changesv1.6.1 Release Package
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
515-533: 💤 Low valueDaemon webhook and A2A share the same default port (8787).
daemon.webhook.portanda2a.portboth default to8787. They're disabled by default so there's no immediate conflict, but enabling both as documented would collide. Consider using distinct sample ports to avoid confusing readers who copy this config.📝 Suggested tweak
"a2a": { "enabled": false, - "port": 8787, + "port": 8788, "host": "127.0.0.1", - "publicUrl": "http://127.0.0.1:8787", + "publicUrl": "http://127.0.0.1:8788",🤖 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 `@README.md` around lines 515 - 533, The README sample uses the same default port for daemon.webhook.port and a2a.port (both 8787), which will collide when both are enabled; update the example so these identifiers use distinct sample ports (e.g., keep daemon.webhook.port at 8787 and change a2a.port and a2a.publicUrl to a different port like 8788) and ensure the related a2a.publicUrl value is updated to match the new a2a.port to keep the example consistent.
🤖 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 `@README.md`:
- Around line 515-533: The README sample uses the same default port for
daemon.webhook.port and a2a.port (both 8787), which will collide when both are
enabled; update the example so these identifiers use distinct sample ports
(e.g., keep daemon.webhook.port at 8787 and change a2a.port and a2a.publicUrl to
a different port like 8788) and ensure the related a2a.publicUrl value is
updated to match the new a2a.port to keep the example consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 08fc8020-0b6c-47b1-8d60-71fc43fd0cdd
📒 Files selected for processing (4)
README.mdsrc/coordination/index.tssrc/index.tstests/unit/consensus-service.test.ts
Summary
CI investigation
The latest
mainCI run is green: https://github.com/blackms/aistack/actions/runs/26638216999.The older red run was a stale Coverage failure in
tests/unit/consensus-service.test.ts: the non-pending expiry test used a real 1ms timeout, so approval could race with expiry under load. This PR makes that test deterministic.Verification
npm run test:unit -- tests/unit/readme-positioning.test.tsnpm run test:unit -- tests/unit/consensus-service.test.tsnpm run typechecknpm run buildnpm run test:integrationnpm run lint(warnings only)npm testSummary by CodeRabbit
New Features
Documentation
Tests