Skip to content

docs(dart): (NOT-TO-MERGE) add gRPC integration documentation#18576

Open
lucas-zimerman wants to merge 1 commit into
masterfrom
lz/doc/dart-grpc
Open

docs(dart): (NOT-TO-MERGE) add gRPC integration documentation#18576
lucas-zimerman wants to merge 1 commit into
masterfrom
lz/doc/dart-grpc

Conversation

@lucas-zimerman

@lucas-zimerman lucas-zimerman commented Jun 27, 2026

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Adds documentation for the upcoming sentry_grpc package introduced in getsentry/sentry-dart#3721.

  • Adds includes/dart-integrations/grpc.mdx with full integration docs (requirements, install, configure, failed request capture, breadcrumbs, tracing, verify)

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jun 27, 2026 2:06am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Jun 27, 2026 2:06am

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team June 27, 2026 01:57
@lucas-zimerman lucas-zimerman changed the title docs(dart): add gRPC integration documentation docs(dart): (NOT-TO-MERGE) add gRPC integration documentation Jun 27, 2026
## Requirements

- `grpc` 4.0.4 or higher
- `sentry_grpc` X or higher

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Bug: The documentation for the sentry_grpc package uses a literal 'X' as a version placeholder instead of the correct version injection syntax.
Severity: LOW

Suggested Fix

Replace the literal 'X' on line 15 with the correct version injection syntax, likely {{@inject packages.version(sentry_grpc)}}, to ensure the correct package version is always displayed in the documentation.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: includes/dart-integrations/grpc.mdx#L15

Potential issue: The documentation file `includes/dart-integrations/grpc.mdx` contains a
literal character 'X' as a placeholder for the required version of the `sentry_grpc`
package. This will render as-is to the user, causing confusion about which version of
the package is needed. Other parts of the documentation correctly use the `{{@inject
packages.version(...)}}` helper to dynamically insert the correct version number.

Did we get this right? 👍 / 👎 to inform future reviews.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

correct, it was intentional, the correct version will be resolved once the first gRPC integration is released


```yml {filename:pubspec.yaml}
dependencies:
sentry: ^{{@inject packages.version('sentry.dart', '9.22.0') }}

@buenaflor buenaflor Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maybe we should add a short comment

sentry: xyz # or sentry_flutter

something like that, since if you use flutter you should use sentry_flutter instead of only sentry

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