Skip to content

docs(node-message-broker): refresh README for the completed broker#18

Merged
tada5hi merged 1 commit into
masterfrom
docs/readme-refresh
Jun 26, 2026
Merged

docs(node-message-broker): refresh README for the completed broker#18
tada5hi merged 1 commit into
masterfrom
docs/readme-refresh

Conversation

@tada5hi

@tada5hi tada5hi commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

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)

  • Replaces the stale "Status" section (which listed the inbound loop, message routes, and analysis policy as "still open") with:
    • a Data flow section — send / wakeup / pull / deliver, noting that analysisId is bound into the HKDF info on both seal and open (so a relabelled metadata.analysisId fails to decrypt rather than mis-routing);
    • an HTTP API table for the flamesdk-compatible container surface (POST /messages, …/broadcast, GET /participants, …/participants/self, subscription CRUD, /healthz) with exact request/response shapes verified against python-sdk;
  • Corrects the Layout to match the real core/ (hub, crypto, delivery, analysis, authz, messaging, inbound) + adapters/ + app/modules tree.
  • Drops the "optional container pull" line — inbound delivery is webhook-push only.

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.

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).
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@tada5hi, we couldn't start this review because you've reached your PR review rate limit.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9f55ead0-d624-4e92-87d4-2f003f00842e

📥 Commits

Reviewing files that changed from the base of the PR and between 90f712a and fb5799b.

📒 Files selected for processing (2)
  • README.md
  • apps/node-message-broker/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-refresh

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.

@tada5hi tada5hi merged commit f679c28 into master Jun 26, 2026
7 checks passed
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