Skip to content

docs(readme): surface the two sibling clients near the top#7

Merged
BlackHole1 merged 1 commit into
mainfrom
docs/readme-sibling-client-nav
Jul 6, 2026
Merged

docs(readme): surface the two sibling clients near the top#7
BlackHole1 merged 1 commit into
mainfrom
docs/readme-sibling-client-nav

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

ProjectConnector (connect accounts for your users) and OpenConnector (self-hosted runtime) are the other two halves of the product, but both sections sat at the very bottom of the README — a reader building for their own users or self-hosting had no early signal they existed.

This adds a > [!TIP] callout right after the hero code block that names the default Connector and links to both sibling sections, so the two alternate entry points are visible near the top. The same callout is mirrored across all five translations (zh-CN, zh-TW, ja, ru, fr), each using its own translated heading anchors and established terminology (managed-auth / 托管认证 / 託管驗證 / マネージド認証 / управляемая аутентификация / authentification gérée). Nothing outside the callout changed.

`ProjectConnector` (connect accounts for your users) and
`OpenConnector` (self-hosted runtime) are the other two halves of the
product, but both sat at the very bottom of the README, so a reader
building for their own users or self-hosting had no early signal they
existed.

Add a `> [!TIP]` callout right after the hero code block that names the
default `Connector` and links to both sibling sections. Mirror it
across all five translations, each using its own translated heading
anchors and established terminology (managed-auth / 托管认证 /
託管驗證 / マネージド認証 / управляемая аутентификация /
authentification gérée).

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 42 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f87d6fa2-bf48-44c2-855e-b58f3f14b937

📥 Commits

Reviewing files that changed from the base of the PR and between 6c977b2 and 690c6ce.

📒 Files selected for processing (6)
  • README.md
  • docs/README/README.fr.md
  • docs/README/README.ja.md
  • docs/README/README.ru.md
  • docs/README/README.zh-CN.md
  • docs/README/README.zh-TW.md
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/readme-sibling-client-nav

Comment @coderabbitai help to get the list of available commands.

@BlackHole1 BlackHole1 merged commit dd0f1aa into main Jul 6, 2026
2 checks passed
@BlackHole1 BlackHole1 deleted the docs/readme-sibling-client-nav branch July 6, 2026 05:31
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