Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add flutter replay docs #11611

Merged
merged 2 commits into from
Oct 23, 2024
Merged

feat: add flutter replay docs #11611

merged 2 commits into from
Oct 23, 2024

Conversation

vaind
Copy link
Collaborator

@vaind vaind commented Oct 18, 2024

DESCRIBE YOUR PR

Resolves #11555

additionally a minor fix to all other mobile replay docs (copy-pasta)

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+

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Oct 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 5:47pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 5:47pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 23, 2024 5:47pm

@vaind vaind changed the title feat: add flutte replay docs feat: add flutter replay docs Oct 18, 2024
@vaind vaind marked this pull request as ready for review October 18, 2024 10:16
Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Made some wording suggestions.

docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
Comment on lines +20 to +23
## Pre-requisites

Make sure your Sentry Flutter SDK version is at least 8.9.0, which is required for Session Replay.
You can update your `pubspec.yaml` to the matching version:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Pre-requisites
Make sure your Sentry Flutter SDK version is at least 8.9.0, which is required for Session Replay.
You can update your `pubspec.yaml` to the matching version:
## Prerequisites
Sentry Flutter SDK version 8.9.0 and up. You can update your `pubspec.yaml` by running the below:

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

by running the below:

that doesn't work here as below is not an executable script. It's a snippet of the configuration file and they already would have the sentry_flutter dependency added - they just need to make sure they have the minimum version with replay available.

docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
docs/platforms/flutter/session-replay/index.mdx Outdated Show resolved Hide resolved
docs/product/explore/session-replay/mobile/index.mdx Outdated Show resolved Hide resolved
docs/product/explore/session-replay/mobile/index.mdx Outdated Show resolved Hide resolved
@vaind
Copy link
Collaborator Author

vaind commented Oct 23, 2024

Made some wording suggestions.

Many thanks!

Copy link

codecov bot commented Oct 23, 2024

Bundle Report

Changes will increase total bundle size by 171 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.52MB 180 bytes (0.0%) ⬆️
sentry-docs-edge-server-array-push 257.08kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.44MB 6 bytes (-0.0%) ⬇️

@vaind vaind merged commit e8bfe3f into master Oct 23, 2024
11 checks passed
@vaind vaind deleted the feat/flutter-replay branch October 23, 2024 17:55
@github-actions github-actions bot locked and limited conversation to collaborators Nov 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Documentation for Flutter Replay
2 participants