Skip to content

docs: refresh README for multi-account launch - #9

Merged
404Dealer merged 2 commits into
masterfrom
docs/readme-public-launch
Jul 14, 2026
Merged

404Dealer merged 2 commits into
masterfrom
docs/readme-public-launch

Conversation

@404Dealer

@404Dealer 404Dealer commented Jul 14, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • align the README with shipped named Gmail and Outlook mailbox profiles
  • remove premature claims that an executable webhook provider is available
  • document conditional Outlook Mail.ReadWrite, named profile configuration, and Gmail --profile onboarding
  • clarify that the hard security boundary depends on the documented OS and credential isolation requirements
  • correct the production audit-log default and keep Quick Start explicitly development-only
  • refresh the project tree and shipped roadmap, and add the active CI badge

Verification

  • npm test — 142/142 passed on the unchanged code at this branch base
  • git diff --check
  • README configuration block parses as YAML with the expected personal and work profile mappings
  • all 26 Markdown fences are balanced
  • all repository-relative README links resolve
  • .github/workflows/ci.yml exists and is active
  • only README.md changed

Scope

Documentation only. No runtime, configuration, credential, deployment, or mailbox changes.

Summary by CodeRabbit

  • Documentation
    • Clarified the security model, including live credential handling and approval boundaries.
    • Updated Quick Start, Telegram setup, draft schema, and production deployment guidance.
    • Added documentation for Outlook named mailbox profiles and Gmail SMTP onboarding.
    • Refined Microsoft Graph permission requirements and audit-log access instructions.
    • Updated project structure and roadmap details, including SMTP App Passwords and gated Spam/Trash cleanup.

Copilot AI review requested due to automatic review settings July 14, 2026 09:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Jul 14, 2026 •

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@404Dealer, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 50 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

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 reviews.

How do review 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 refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 08cfb9e3-0f8b-4707-b56e-af4981f574b2

📥 Commits

Reviewing files that changed from the base of the PR and between 7c52f9f and c4e7367.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

README documentation is updated for the security model, local and production setup, mailbox-profile onboarding, provider scopes, audit-log access, project structure, and shipped roadmap capabilities.

Changes

README documentation updates

Layer / File(s) Summary
Security model and control-plane guidance
README.md
Clarifies structural isolation, credential handling, approval comparisons, reserved webhook schema status, and agent access boundaries.
Setup, provider configuration, and deployment guidance
README.md
Revises Quick Start, Telegram, mailbox-profile, SMTP, Outlook, and audit-log instructions.
Project structure and shipped roadmap reference
README.md
Updates the CI badge, project and docs listings, and shipped SMTP and Gmail cleanup entries.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README documentation refresh for the multi-account launch.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-public-launch

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 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.

Inline comments:
In `@README.md`:
- Around line 489-492: Update the README project-tree listing near the docs
entries to include credential-handoff.md and mailbox-cleanup.md with
descriptions matching their linked documentation, or explicitly mark the tree as
intentionally abbreviated; keep the documented tree consistent with the README
links.
- Line 233: Update the README configuration example around the mailboxAccess
setting to default to send-only Outlook access by removing or disabling
mailboxAccess and its named mailbox profile from the basic example. Add a
separate named-profile snippet that explicitly enables mailboxAccess and retains
the required profile configuration, while preserving the existing scope
guidance.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 817f4fbb-3beb-4611-aade-a4f38221f54e

📥 Commits

Reviewing files that changed from the base of the PR and between 4810766 and 7c52f9f.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Resolved
Comment thread README.md Resolved
@404Dealer

Copy link
Copy Markdown
Owner Author

Addressed both CodeRabbit findings in c4e7367:

  • kept the base Outlook example send-only and moved mailboxAccess: true into a separate named-profile opt-in example;
  • added credential-handoff.md and mailbox-cleanup.md to the documented project tree.

Revalidated both YAML examples, all Markdown fences, repository-relative links, and git diff --check. Refreshed Node 20/22 CI is green.

@404Dealer
404Dealer merged commit 9bb0f83 into master Jul 14, 2026
3 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.

2 participants