docs(node-message-broker): refresh README for the completed broker#18
Conversation
The service was feature-complete (S1–S6) but its README still described the build as "in progress". Replace the stale Status section with: - a Data flow section (send / wakeup / pull / deliver) noting the analysisId HKDF binding, - an HTTP API table for the flamesdk-compatible container surface, and - a Layout that matches the actual core/ + adapters/ + app/modules tree. Also tighten the root README service description (flamesdk-compatible, pulls inbound).
|
Warning Review limit reached
More reviews will be available in 27 minutes and 54 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ 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 |
Summary
Refreshes the documentation now that the message broker is feature-complete (S1–S6 all merged). The service README still described the build as "in progress" with an outdated layout and no API reference.
Service README (
apps/node-message-broker/README.md)analysisIdis bound into the HKDFinfoon bothsealandopen(so a relabelledmetadata.analysisIdfails to decrypt rather than mis-routing);flamesdk-compatible container surface (POST /messages,…/broadcast,GET /participants,…/participants/self, subscription CRUD,/healthz) with exact request/response shapes verified againstpython-sdk;core/(hub, crypto, delivery, analysis, authz, messaging, inbound) +adapters/+app/modulestree.The env-var/Configuration table was already accurate (verified against
config/constants.ts) and is unchanged.Root README
Tightens the service description:
flamesdk-compatible, node-to-node E2E crypto, pulls inbound from the Hub mailbox.Docs-only — no code changes.