Skip to content

docs(replay): screenshot-only mobile replay for Android and iOS 4.0 - #21741

Closed
turnipdabeets wants to merge 6 commits into
masterfrom
docs/mobile-replay-drop-wireframe
Closed

turnipdabeets wants to merge 6 commits into
masterfrom
docs/mobile-replay-drop-wireframe

Conversation

@turnipdabeets

@turnipdabeets turnipdabeets commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Important

Draft until posthog-android 4.0 and posthog-ios 4.0 ship. Stacked on #21651, which merges first. GitHub retargets this to master when that branch is deleted. Companion monorepo PR for the generated install steps: PostHog/posthog#125537.

Changes

posthog-android 4.0 (PostHog/posthog-android#908) and posthog-ios 4.0 (PostHog/posthog-ios#907, PostHog/posthog-ios#973) remove wireframe session replay. Replay always records masked screenshots, and screenshot / screenshotMode are gone. posthog-kmp removes SessionRecordingConfig.screenshot (PostHog/posthog-kmp#109).

  • session-replay/mobile.mdx: screenshot mode is now the main section. It says all SDKs record screenshots (Android and iOS from 4.0) and that screenshots show anything that isn't masked, such as custom-drawn views, maps and video. Wireframe mode moves to a "before 4.0" section that keeps the screenshot / screenshotMode instructions for 3.x users.
  • session-replay/start-here.mdx, session-replay/installation/index.mdx: drop "wireframe-only mode unless screenshot mode is enabled" from the mobile limitations.
  • libraries/kmp/index.mdx: replace the screenshot-mode example and the screenshot table row with a note on masking and on the option's removal. On top of docs(kmp): explain Android screenshot mask alignment verification #21651, drop screenshot = true from its verifyScreenshotMaskAlignment example and say "Android" rather than "Android screenshot mode".
  • libraries/kmp/index.mdx, other 4.0 changes: add an "Upgrade to 0.11.0" section. It lists the changes that KMP gets from the native 4.0 SDKs on Android, iOS, macOS and the JVM: the /i/v1/analytics/events path for proxies and self-hosted instances, $lib/$lib_version set from the request, the SDK disabled for a phx_ key, register values that replace SDK properties, and the macOS 11 minimum. Add the missing macOS (Apple silicon) row to the platform table.

Before merging:

Not changed here:

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json (no pages moved)

Vale shows no new warnings on the changed lines. Not rendered locally.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Written with Claude Code (Opus 5.5) at the maintainer's request, alongside the Android, KMP and React Native wireframe-removal PRs.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Nov 05, 2026 09:20PM

Changed pages

Page Source
Kotlin Multiplatform contents/docs/libraries/kmp/index.mdx
Session Replay installation contents/docs/session-replay/installation/index.mdx
Mobile session replay contents/docs/session-replay/mobile.mdx
Get started with Session Replay contents/docs/session-replay/start-here.mdx

@github-actions github-actions Bot added docs Improvements or additions to product documentation, "Docs" content PR only touches files under contents/ labels Oct 29, 2026
@github-actions

github-actions Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 0 errors, 75 warnings, 6 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/libraries/kmp/index.mdx — 0 errors, 52 warnings, 6 suggestions
Line Severity Message Rule
6:18 warning Use 'GitHub' instead of 'github'. Vale.Terms
6:37 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
21:35 warning Use 'kmp' instead of 'KMP'. Vale.Terms
21:436 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
96:98 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
154:6 warning 'JVM (desktop)' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
169:7 warning 'Configure Compose Desktop release builds' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
213:177 warning 'Gson' is a possible misspelling. PostHogBase.Spelling
213:217 warning 'deserializes' is a possible misspelling. PostHogBase.Spelling
213:327 warning 'Gson' is a possible misspelling. PostHogBase.Spelling
213:356 warning 'Okio' is a possible misspelling. PostHogBase.Spelling
215:170 warning Use 'kmp' instead of 'KMP'. Vale.Terms
217:205 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
256:38 warning Use 'kmp' instead of 'KMP'. Vale.Terms
306:93 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
361:44 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
363:44 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
363:75 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
373:4 warning 'Feature flags' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
373:4 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
379:23 warning 'preloaded' is a possible misspelling. PostHogBase.Spelling
417:1 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
427:8 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
427:55 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
435:28 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
435:54 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
487:4 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
487:4 warning 'Error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
522:4 warning 'Session replay' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
522:4 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
524:2 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
627:10 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
627:90 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
627:99 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
643:34 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
643:52 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
643:121 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
668:56 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
675:84 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
702:69 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
703:59 warning 'logcat' is a possible misspelling. PostHogBase.Spelling
704:54 warning 'debounce' is a possible misspelling. PostHogBase.Spelling
717:128 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
719:44 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
719:67 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
719:437 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
729:5 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
729:75 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
731:4 warning 'FAQ' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
733:30 warning Use 'kmp' instead of 'KMP'. Vale.Terms
739:81 warning Use 'kmp' instead of 'KMP'. Vale.Terms
741:21 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
741:32 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
743:5 warning Use 'kmp' instead of 'KMP'. Vale.Terms
743:66 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
743:115 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
743:135 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
743:163 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
contents/docs/session-replay/_snippets/android-privacy.mdx — 0 errors, 10 warnings, 0 suggestions
Line Severity Message Rule
5:128 warning 'contentDescription' is a possible misspelling. PostHogBase.Spelling
18:179 warning 'contentDescription' is a possible misspelling. PostHogBase.Spelling
29:5 warning 'Masking in Jetpack Compose' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
29:16 warning 'Jetpack' is a possible misspelling. PostHogBase.Spelling
43:5 warning 'Unmasking in Jetpack Compose' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
43:18 warning 'Jetpack' is a possible misspelling. PostHogBase.Spelling
56:5 warning 'Automatic masking in Jetpack Compose' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
56:26 warning 'Jetpack' is a possible misspelling. PostHogBase.Spelling
65:257 warning 'subtree' is a possible misspelling. PostHogBase.Spelling
65:425 warning 'subtree' is a possible misspelling. PostHogBase.Spelling
contents/docs/session-replay/installation/index.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
12:1 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
contents/docs/session-replay/mobile.mdx — 0 errors, 7 warnings, 0 suggestions
Line Severity Message Rule
2:15 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
5:20 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
7:8 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
7:126 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
39:12 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
40:8 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
42:12 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
contents/docs/session-replay/start-here.mdx — 0 errors, 5 warnings, 0 suggestions
Line Severity Message Rule
20:83 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
46:147 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
74:1 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
98:100 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
114:1 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames

…iOS 4.0

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@turnipdabeets
turnipdabeets force-pushed the docs/mobile-replay-drop-wireframe branch from fb6a943 to e6e810a Compare October 29, 2026 14:46
@turnipdabeets
turnipdabeets changed the base branch from master to docs/kmp-verify-screenshot-mask-alignment October 29, 2026 14:46
@github-actions

github-actions Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

11.70 MiB (+0.1 KiB / +0.0%)

Eager graph (modules shipped in each entrypoint's initial chunks)

Entrypoint Eager size Budget Modules
✅ app 9.94 MiB (no change) report-only 1023
Largest modules in the app closure
Module Size
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css 838.6 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js 354.8 KiB
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules 351.4 KiB
./node_modules/.pnpm/framer-motion@14.0.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/framer-motion/dist/es/render/components/motion/proxy.mjs + 126 modules 287.2 KiB
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js 281.9 KiB
./src/components/SearchUI/index.tsx + 87 modules 273.1 KiB
./gatsby-browser.tsx + 59 modules 259.1 KiB
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/construction-1.mjs 248.5 KiB
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules 240.2 KiB
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/construction-2.mjs 228.2 KiB
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/magnifying-glass.mjs 221.7 KiB
./src/hooks/useProducts.tsx + 23 modules 153.9 KiB
./src/hooks/skills.tsx + 2 modules 150.7 KiB
./src/hooks/useProduct.ts + 9 modules 150.0 KiB

Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes for the modules actually shipped in the entrypoint's initial chunks (post-tree-shake).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Base automatically changed from docs/kmp-verify-screenshot-mask-alignment to master November 5, 2026 19:40
…eframe mode, document 4.0 Compose masking

- delete the unimported session-replay/_snippets/android-installation.mdx (apiKey, screenshot option, wireframe limitations)
- set PostHog's wireframe_mode to false in the comparison data and make its definition vendor-neutral
- document clearAndSetSemantics masking, overflowing text masking and mask/unmask scope in 4.0

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot removed the content PR only touches files under contents/ label Nov 5, 2026
Resolve the kmp/index.mdx conflict on the verifyScreenshotMaskAlignment
row in favor of this branch (screenshot captures, since screenshots are
the only mode). Drop the $lib/$lib_version claim from the 0.11.0 upgrade
list: the native SDKs keep per-event values and ingestion behavior is
still changing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@turnipdabeets

Copy link
Copy Markdown
Contributor Author

Split by release: the Android snippets moved to #21808, the shared mobile replay pages to #21807 (Android and iOS 4.0 ship together), and the KMP page changes to #22013.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to product documentation, "Docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants