Skip to content

docs: add Protocol Buffers integration guide - #84

Merged
easyhooon merged 1 commit into
mainfrom
codex/docs-protobuf-guide
Aug 4, 2026
Merged

easyhooon merged 1 commit into
mainfrom
codex/docs-protobuf-guide

Conversation

@easyhooon

Copy link
Copy Markdown
Owner

Summary

  • add dedicated English and Korean Protocol Buffers pages to the documentation sidebar
  • clarify that protobuf inspection has no feature flag and is enabled through the decoder overload and protobuf capture methods
  • document decoder setup, all request/response directions, request ID pairing, Base64 transport, raw capture limits, and runtime behavior
  • show the Decoded and Raw views with light-mode screenshots and explain that both views are available for REQUEST and RESPONSE
  • link the full guides from the README and keep the interceptor API pages concise

Validation

  • npm run build in documentation/
  • verified /docs/protobuf and /ko/docs/protobuf static output and public image assets
  • pre-commit detekt and ktlint checks

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 14 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

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 Plus

Run ID: 561930ba-0326-4382-b83e-0af74bfb0a9e

📥 Commits

Reviewing files that changed from the base of the PR and between 8196d7d and db32461.

⛔ Files ignored due to path filters (2)
  • documentation/public/protobuf-decoded.png is excluded by !**/*.png
  • documentation/public/protobuf-raw.png is excluded by !**/*.png
📒 Files selected for processing (7)
  • README.md
  • documentation/content/docs/interceptor.mdx
  • documentation/content/docs/ko/interceptor.mdx
  • documentation/content/docs/ko/meta.json
  • documentation/content/docs/ko/protobuf.mdx
  • documentation/content/docs/meta.json
  • documentation/content/docs/protobuf.mdx

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.

@easyhooon
easyhooon merged commit 3921ce6 into main Aug 4, 2026
3 checks passed
@easyhooon
easyhooon deleted the codex/docs-protobuf-guide branch August 4, 2026 04:45
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