sentry-rust icon indicating copy to clipboard operation
sentry-rust copied to clipboard

Align docs with SDK features

Open lcian opened this issue 4 months ago • 0 comments
trafficstars

Description

There are some discrepancies between the docs on docs.sentry.io and what's offered in the SDK:

  • https://docs.sentry.io/platforms/rust/configuration/releases/ this should mention how to use sessions and that release-health is needed
  • https://docs.sentry.io/platforms/rust/configuration/filtering/ here we mention hints but the SDK does not support them
  • https://docs.sentry.io/platforms/rust/configuration/options/ we should review this and fix the discrepancies
  • https://docs.sentry.io/platforms/rust/usage/ there's some generic information that refers to SDKs in general, make it specific to this SDK
  • https://docs.sentry.io/platforms/rust/enriching-events/breadcrumbs/ same as above
  • https://docs.sentry.io/platforms/rust/enriching-events/context/ same as above
  • https://docs.sentry.io/platforms/rust/data-management/sensitive-data/ same as above
  • https://docs.sentry.io/platforms/rust/user-feedback/ should this be here at all? Check other SDKs
  • https://docs.sentry.io/platforms/rust/security-policy-reporting/ should this be here at all? Check other SDKs
  • document how to set up source code mapping

Fix them.

lcian avatar Jun 25 '25 09:06 lcian