docs(dart): (NOT-TO-MERGE) add gRPC integration documentation#18576
docs(dart): (NOT-TO-MERGE) add gRPC integration documentation#18576lucas-zimerman wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| ## Requirements | ||
|
|
||
| - `grpc` 4.0.4 or higher | ||
| - `sentry_grpc` X or higher |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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') }} |
There was a problem hiding this comment.
maybe we should add a short comment
sentry: xyz # or sentry_fluttersomething like that, since if you use flutter you should use sentry_flutter instead of only sentry
DESCRIBE YOUR PR
Adds documentation for the upcoming
sentry_grpcpackage introduced in getsentry/sentry-dart#3721.includes/dart-integrations/grpc.mdxwith 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.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: