Skip to content

Add Android and iOS Session Replay Wireframes (Beta) documentation - #215

Merged
myronkaifung merged 5 commits into
mainfrom
docs/session-replay-wireframes-beta
Sep 9, 2026
Merged

myronkaifung merged 5 commits into
mainfrom
docs/session-replay-wireframes-beta

Conversation

@tylerjroach

@tylerjroach tylerjroach commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a self-contained Wireframes (Beta) section to the Android and iOS Session Replay SDK pages, following the existing convention that each SDK page stands on its own rather than linking to a shared concept page.

Flutter and React Native documentation has been split into draft PR #237 until those SDK releases are ready.

Changes

Each platform section covers:

  • Enabling capture via wireframesOptions, with the options table
  • How the four masking layers apply to wireframe text
  • Declaring text for an element, and redacting by pattern
  • Verifying output with debugOptions.wireframeEmitter and the per-element maskDecision
  • Risks to mitigate, with the mitigation for each

The documentation uses each platform’s API vocabulary and notes the known platform gaps: transparent composables on Compose and no scraped text on SwiftUI.

Version callouts can be added alongside the Android and iOS SDK releases.

Adds a self-contained "Wireframes (Beta)" section to each of the four
mobile Session Replay SDK pages (Android, Swift, Flutter, React Native),
following the existing convention that each SDK page stands on its own
rather than linking out to a shared concept page.

Each section covers:

- Enabling capture via `wireframesOptions`, with the options table
- How the four masking layers apply to wireframe text
- Declaring text for an element, and redacting by pattern
- Verifying output with `debugOptions.wireframeEmitter` and the
  per-element `maskDecision`
- Risks to mitigate, with the mitigation for each

Written in each platform's own API vocabulary, and each carries its own
known gap: transparent composables on Compose, no scraped text on
SwiftUI, and legacy-architecture `<Text>` on React Native.

No version callouts yet — the SDK minors carrying wireframes are not cut,
so those need adding at release time along with a changelog entry.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mixpanel-docs 🟢 Ready View Preview Aug 31, 2026, 8:24 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

The PR appears safe to merge with no actionable new issues identified.

The platform-specific documentation consistently explains wireframe configuration, masking precedence, validation, and privacy limitations; no blocking failure remains.

Important Files Changed

Filename Overview
docs/tracking-methods/sdks/android/android-replay.mdx Adds Android wireframe setup, masking, validation, and privacy-risk guidance.
docs/tracking-methods/sdks/swift/swift-replay.mdx Adds equivalent Swift guidance, including SwiftUI’s lack of scraped text.

Reviews (5): Last reviewed commit: "Merge branch 'main' into docs/session-re..." | Re-trigger Greptile

@tylerjroach tylerjroach changed the title Add Mobile Session Replay Wireframes (Beta) documentation Add Android and iOS Session Replay Wireframes (Beta) documentation Sep 9, 2026
@tylerjroach
tylerjroach marked this pull request as ready for review September 9, 2026 20:21
@tylerjroach
tylerjroach requested a review from a team as a code owner September 9, 2026 20:21
@tylerjroach
tylerjroach requested a review from pouseaoe September 9, 2026 20:21
@tylerjroach

Copy link
Copy Markdown
Contributor Author

Don't auto merge once approved. I'll approve once Android and iOS are live (releases in progress)

@tylerjroach
tylerjroach enabled auto-merge (squash) September 9, 2026 20:59
@myronkaifung
myronkaifung merged commit 04a0e67 into main Sep 9, 2026
6 checks passed
@myronkaifung
myronkaifung deleted the docs/session-replay-wireframes-beta branch September 9, 2026 21:33
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.

3 participants