Skip to content

docs(ios): posthog-ios 4.0 snippets and screenshot-only mobile replay - #21807

Merged
turnipdabeets merged 35 commits into
masterfrom
docs/ios-4-upgrade-guide
Nov 20, 2026
Merged

turnipdabeets merged 35 commits into
masterfrom
docs/ios-4-upgrade-guide

Conversation

@turnipdabeets

@turnipdabeets turnipdabeets commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Important

Hold until posthog-ios 4.0.0 is released.

Depends on:

Changes

Updates the pages that posthog-ios 4.0 makes wrong. The upgrade guide itself is the SDK's MIGRATION.md, shown at /docs/libraries/ios/migration.

  • integrate/_snippets/install-ios.mdx: Swift Package Manager only, from: "4.0.0", new requirements line, note that version 3 stays on CocoaPods, and a link to the migration page.
  • feature-flags-code-ios.mdx: reloadFeatureFlags closure takes the result; the didReceiveFeatureFlags snippet is replaced by a pointer to onFeatureFlags; new isFeatureEnabled(_:defaultValue:) section.
  • session-replay/_snippets/ios-installation.mdx: deleted. Nothing imports it, and it documented screenshotMode.
  • error-tracking/upload-source-maps/ios.mdx: CocoaPods tabs labeled version 3.
  • error-tracking/installation/ios.mdx: the SIGTRAP limitation applies only before 3.57.3, which captures the Swift crash message (posthog-ios#577). The page's install steps, including the in-app frames default that changes in 4.0, come from docs(onboarding): update ios onboarding for posthog-ios 4.0 posthog#129618.
  • feature-flags/evaluation-contexts.mdx: the iOS example uses projectToken. The iOS "removed in 4.0.0" row is in docs(android): posthog-android 4.0 snippets and replay docs #21808, next to the Android row.
  • product-analytics/installation/ios.mdx, logs/installation/ios.mdx, health-checks/keeping-sdks-current.mdx: Swift Package Manager first; CocoaPods only for version 3.
  • product-analytics/installation/ios.eval.yaml: the install check is graded for posthog-ios 4 and fails a CocoaPods install; the install-next check is removed.
  • session-replay/_snippets/ios-privacy.mdx: the Xcode 26 callout says 4.x requires Xcode 26 and includes the SwiftUI masking fix. From 4.0, secure-entry fields stay masked inside a ph-no-mask subtree.
  • learn/session-replay/pocket-guide/protecting-user-privacy/: iOS and Android record masked screenshots from 4.0.
  • libraries/ios/index.mdx: the CocoaPods callout says version 4 is Swift Package Manager only.
  • libraries/ios/configuration.mdx: maxRetries becomes pushNotificationSubscriptionMaxRetries, described as push-only (true since 3.73), and the rows for evaluationEnvironments, .cellular and propertiesSanitizer say 4.0 removes them.
  • teams/client-libraries/objectives.mdx: the wireframe goal is marked done in posthog-ios and posthog-android 4.0.
  • session-replay/_snippets/ios-logging.mdx: renamed console log types.
  • workflows/push-notifications/ios.mdx: iOS requirement, projectToken.
  • tutorials/ios-*.md: projectToken; drop screenshotMode and the CocoaPods mention.
  • session-replay/mobile.mdx: screenshot mode becomes the main section. It says Android and iOS record screenshots from 4.0 (Kotlin Multiplatform isn't listed until docs(kmp): update for posthog-kmp 0.12 #22013), that screenshots show anything not masked, and how iOS records WKWebView. Wireframe mode moves to a "before 4.0" section.
  • session-replay/start-here.mdx, session-replay/installation/index.mdx: drop "wireframe-only mode" from the mobile limitations.
  • competitorData/posthog.tsx, featureDefinitions/session_replay.tsx: wireframe_mode is now false, and its description no longer sells wireframes as low impact.

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)

Claims were checked against chore/v4-remove-deprecated and #938's diff. Vale reports 0 errors on the changed files, with warnings I didn't triage line by line. Not rendered locally, and the Swift snippets weren't compiled.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Written with Claude Code (Opus 5.5) as part of the 4.0 release docs audit.

Regrouped by release: the shared mobile replay pages moved here from #21741, which is closed.

🤖 Generated with Claude Code

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

github-actions Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Nov 20, 2026 12:20AM

Changed pages

Page Source
iOS Error Tracking installation contents/docs/error-tracking/installation/ios.mdx
Upload dSYMs for iOS contents/docs/error-tracking/upload-source-maps/ios.mdx
Evaluation contexts contents/docs/feature-flags/evaluation-contexts.mdx
Keeping SDKs current contents/docs/health-checks/keeping-sdks-current.mdx
iOS contents/docs/libraries/ios/index.mdx
iOS SDK configuration contents/docs/libraries/ios/configuration.mdx
iOS Logs installation contents/docs/logs/installation/ios.mdx
iOS Product Analytics installation contents/docs/product-analytics/installation/ios.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
iOS push notifications contents/docs/workflows/push-notifications/ios.mdx
Protecting user privacy contents/learn/session-replay/pocket-guide/protecting-user-privacy/index.mdx
How to run A/B tests in iOS contents/tutorials/ios-ab-tests.md
How to set up analytics in iOS contents/tutorials/ios-analytics.md
How to set up feature flags in iOS contents/tutorials/ios-feature-flags.md
How to set up iOS remote config contents/tutorials/ios-remote-config.md
How to set up iOS session replay contents/tutorials/ios-session-replay.md

@github-actions

github-actions Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 0 errors, 209 warnings, 4 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/error-tracking/installation/ios.mdx — 0 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'iOS' instead of 'ios'. Vale.Terms
23:38 warning 'symbolicated' is a possible misspelling. PostHogBase.Spelling
23:52 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
contents/docs/error-tracking/upload-source-maps/ios.mdx — 0 errors, 19 warnings, 0 suggestions
Line Severity Message Rule
2:15 warning 'dSYMs' is a possible misspelling. PostHogBase.Spelling
12:252 warning 'Tracking's' is a possible misspelling. PostHogBase.Spelling
32:53 warning 'dSYMs' is a possible misspelling. PostHogBase.Spelling
49:30 warning 'Sandboxing' is a possible misspelling. PostHogBase.Spelling
51:48 warning 'Sandboxing' is a possible misspelling. PostHogBase.Spelling
56:18 warning 'Sandboxing' is a possible misspelling. PostHogBase.Spelling
65:4 warning 'symbolicate' is a possible misspelling. PostHogBase.Spelling
65:144 warning 'dSYMs' is a possible misspelling. PostHogBase.Spelling
116:112 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
136:10 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
136:18 warning Use 'iOS' instead of 'ios'. Vale.Terms
136:50 warning Use 'CLI' instead of 'cli'. Vale.Terms
178:11 warning 'uncheck' is a possible misspelling. PostHogBase.Spelling
186:15 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
202:5 warning 'Script fails with "error: posthog-cli not found"' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
202:31 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
202:39 warning Use 'CLI' instead of 'cli'. Vale.Terms
218:5 warning 'dSYMs not being generated' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
218:5 warning 'dSYMs' is a possible misspelling. PostHogBase.Spelling
contents/docs/feature-flags/evaluation-contexts.mdx — 0 errors, 10 warnings, 0 suggestions
Line Severity Message Rule
13:75 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
28:9 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
42:69 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
43:21 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
44:13 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
44:37 warning Use 'API' instead of 'api'. Vale.Terms
45:17 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
60:64 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
161:237 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
167:16 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
contents/docs/health-checks/keeping-sdks-current.mdx — 0 errors, 12 warnings, 0 suggestions
Line Severity Message Rule
55:5 warning 'Dependabot' is a possible misspelling. PostHogBase.Spelling
55:28 warning 'misconfiguration' is a possible misspelling. PostHogBase.Spelling
57:100 warning 'Dependabot' is a possible misspelling. PostHogBase.Spelling
90:166 warning Use 'project token' instead of 'project API key'. The project token (phc_) is not an API key. PostHogBase.ProjectToken
98:1 warning 'Dependabot' is a possible misspelling. PostHogBase.Spelling
128:3 warning 'Dependabot' is a possible misspelling. PostHogBase.Spelling
128:17 warning 'Dependabot' is a possible misspelling. PostHogBase.Spelling
128:134 warning 'Dependabot' is a possible misspelling. PostHogBase.Spelling
162:38 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
162:47 warning Use 'X' instead of 'x'. Vale.Terms
258:89 warning 'outdatedness' is a possible misspelling. PostHogBase.Spelling
260:6 warning 'Services, CMS no-code builders, etc.' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
contents/docs/integrate/_snippets/install-ios.mdx — 0 errors, 5 warnings, 0 suggestions
Line Severity Message Rule
2:11 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
7:147 warning 'toolchains' is a possible misspelling. PostHogBase.Spelling
7:293 warning Use 'X' instead of 'x'. Vale.Terms
9:5 warning 'Swift Package Manager' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
35:33 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
contents/docs/integrate/feature-flags-code/_snippets/feature-flags-code-ios.mdx — 0 errors, 11 warnings, 0 suggestions
Line Severity Message Rule
1:13 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
20:18 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
46:20 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
48:38 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
56:15 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
58:91 warning 'refetch' is a possible misspelling. PostHogBase.Spelling
66:83 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
68:39 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
94:46 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
96:56 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
98:63 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
contents/docs/libraries/ios/configuration.mdx — 0 errors, 29 warnings, 1 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
6:45 warning Use 'iOS' instead of 'ios'. Vale.Terms
71:97 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
183:5 warning 'Chaining multiple BeforeSendBlocks' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
208:25 warning 'beforeSend' is a possible misspelling. PostHogBase.Spelling
223:180 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
223:196 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
231:138 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
232:3 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
233:45 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
247:234 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
267:115 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
271:214 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
271:233 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
272:104 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
273:89 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
274:226 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
274:242 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
275:87 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
275:111 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
275:172 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
276:94 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
278:78 warning 'Preload' is a possible misspelling. PostHogBase.Spelling
278:86 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
279:136 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
282:163 warning Use 'ID' instead of 'id'. Vale.Terms
287:178 warning Use 'iOS' instead of 'ios'. Vale.Terms
289:119 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
294:119 warning Use 'ID' instead of 'Id'. Vale.Terms
contents/docs/libraries/ios/index.mdx — 0 errors, 11 warnings, 0 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
6:45 warning Use 'iOS' instead of 'ios'. Vale.Terms
7:15 warning Use 'iOS' instead of 'ios'. Vale.Terms
25:117 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
25:136 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
25:155 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
35:218 warning Use 'X' instead of 'x'. Vale.Terms
59:60 warning 'sandboxed' is a possible misspelling. PostHogBase.Spelling
69:169 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
69:185 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
contents/docs/logs/installation/ios.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
4:15 warning Use 'iOS' instead of 'ios'. Vale.Terms
contents/docs/product-analytics/installation/ios.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'iOS' instead of 'ios'. Vale.Terms
23:28 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
contents/docs/session-replay/_snippets/ios-logging.mdx — 0 errors, 18 warnings, 0 suggestions
Line Severity Message Rule
1:12 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
1:76 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
13:37 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
15:28 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
27:25 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
56:47 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
70:6 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
82:5 warning 'OSLog' is a possible misspelling. PostHogBase.Spelling
86:5 warning 'OSLog' is a possible misspelling. PostHogBase.Spelling
92:66 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
93:14 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
94:3 warning 'OSLog' is a possible misspelling. PostHogBase.Spelling
94:19 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
96:18 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
97:20 warning 'stdout' is a possible misspelling. PostHogBase.Spelling
98:19 warning 'stderr' is a possible misspelling. PostHogBase.Spelling
99:3 warning 'OSLog' is a possible misspelling. PostHogBase.Spelling
100:3 warning 'NSLog' is a possible misspelling. PostHogBase.Spelling
contents/docs/session-replay/_snippets/ios-privacy.mdx — 0 errors, 12 warnings, 0 suggestions
Line Severity Message Rule
5:81 warning 'accessibilityIdentifier' is a possible misspelling. PostHogBase.Spelling
16:46 warning 'subviews' is a possible misspelling. PostHogBase.Spelling
16:144 warning 'accessibilityIdentifier' is a possible misspelling. PostHogBase.Spelling
16:284 warning 'accessibilityLabel' is a possible misspelling. PostHogBase.Spelling
23:33 warning 'substring' is a possible misspelling. PostHogBase.Spelling
29:11 warning Use 'X' instead of 'x'. Vale.Terms
57:98 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
59:11 warning Use 'X' instead of 'x'. Vale.Terms
65:62 warning 'subviews' is a possible misspelling. PostHogBase.Spelling
65:231 warning 'subtree' is a possible misspelling. PostHogBase.Spelling
65:488 warning 'subtree' is a possible misspelling. PostHogBase.Spelling
65:524 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
contents/docs/workflows/push-notifications/ios.mdx — 0 errors, 10 warnings, 3 suggestions
Line Severity Message Rule
12:192 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
13:28 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
13:79 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
13:98 warning Use 'ID' instead of 'id'. Vale.Terms
28:199 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
52:9 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
72:1 warning 'Unregister' is a possible misspelling. PostHogBase.Spelling
78:52 warning 'unregisters' is a possible misspelling. PostHogBase.Spelling
78:142 warning Use 'ID' instead of 'id'. Vale.Terms
80:18 warning 'unregistration' is a possible misspelling. PostHogBase.Spelling
120:83 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
121:47 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
121:120 warning Use 'ID' instead of 'id'. Vale.Terms
contents/learn/session-replay/pocket-guide/protecting-user-privacy/SKILL.md — 0 errors, 8 warnings, 0 suggestions
Line Severity Message Rule
36:39 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
36:47 warning Use 'iOS' instead of 'ios'. Vale.Terms
36:59 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
36:67 warning Use 'Android' instead of 'android'. Vale.Terms
40:4 warning 'Step one: mask everything' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
51:4 warning 'Step two: propose what to reveal' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
67:4 warning 'Step three: apply only what was approved' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
81:4 warning 'Step four: the things masking doesn't cover' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
contents/learn/session-replay/pocket-guide/protecting-user-privacy/index.mdx — 0 errors, 5 warnings, 0 suggestions
Line Severity Message Rule
41:45 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
41:53 warning Use 'Android' instead of 'android'. Vale.Terms
42:41 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
42:49 warning Use 'iOS' instead of 'ios'. Vale.Terms
52:4 warning 'Blindspots' is a possible misspelling. PostHogBase.Spelling
contents/teams/client-libraries/objectives.mdx — 0 errors, 8 warnings, 0 suggestions
Line Severity Message Rule
29:1 warning 'Goal 3: Bring mobile session replay to feature parity with web (Driver: ** )' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
29:27 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
31:39 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
31:63 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
31:71 warning Use 'iOS' instead of 'ios'. Vale.Terms
31:83 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
31:91 warning Use 'Android' instead of 'android'. Vale.Terms
32:12 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
contents/tutorials/ios-ab-tests.md — 0 errors, 8 warnings, 0 suggestions
Line Severity Message Rule
17:45 warning Use 'Xcode' instead of 'XCode'. Vale.Terms
84:13 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
84:21 warning Use 'iOS' instead of 'ios'. Vale.Terms
90:66 warning 'initializer' is a possible misspelling. PostHogBase.Spelling
131:15 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
137:54 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
209:22 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
211:18 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
contents/tutorials/ios-analytics.md — 0 errors, 6 warnings, 0 suggestions
Line Severity Message Rule
19:2 warning Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. PostHogBase.ProductNames
155:15 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
234:23 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
269:18 warning Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. PostHogBase.ProductNames
291:18 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
292:22 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
contents/tutorials/ios-feature-flags.md — 0 errors, 6 warnings, 0 suggestions
Line Severity Message Rule
2:22 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
16:2 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
24:45 warning Use 'Xcode' instead of 'XCode'. Vale.Terms
117:15 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
128:44 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
182:22 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
contents/tutorials/ios-remote-config.md — 0 errors, 4 warnings, 0 suggestions
Line Severity Message Rule
20:23 warning Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. PostHogBase.LatinAbbreviationComma
73:15 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
138:14 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
148:4 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
contents/tutorials/ios-session-replay.md — 0 errors, 8 warnings, 0 suggestions
Line Severity Message Rule
2:26 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
10:2 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
12:79 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
14:38 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
203:15 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
203:170 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
212:4 warning '3. (Optional) Mask sensitive data' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
246:18 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames

@posthog posthog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PostHog Review · Standard · reviewed b6b6ca5: 1 Should fix.

This is the only automatic review while this pull request is a draft. Comment @posthog review to review new changes sooner. Otherwise, a review of the new changes runs when you mark it ready for review.

See this review and its findings in PostHog Review. Comment @posthog review --deep for a Deep review. A Deep review takes longer and looks deeper than a Standard review.

Comment thread contents/tutorials/ios-analytics.md Resolved
@github-actions

github-actions Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

12.21 MiB (+153.2 KiB / +1.2%)

Largest changed named chunks
Chunk Gzip Δ vs master
490bc41e476e65d6e70047bd978778ccbdbc6b56.js 450.6 KiB new
2461c6025d2bedd130ec0d6eb3c75cde5c20a8d5.js 130.2 KiB new
e01beff9.js 77.9 KiB new
d1c09c67.js 68.4 KiB new
49b4b7068874fb7dcec1b52226ab714029d5d40a.js 60.9 KiB new
cfcc9e3efb38a26457e476c440637982c52f7652.js 49.0 KiB new
component---src-templates-ui-library-docs-tsx.js 298.1 KiB -29.8 KiB / -9.1%
e90d6e7089cae1aeeb7f639d10b83b4a5acb53f3.js 29.7 KiB new
740846d0b8a7fcb004e98b07aa0e2a91e26d193f.js 23.3 KiB new
cf31b3f00f3e3b512c2c681b9f0ea1360d74f666.js 16.4 KiB new
441c3a0be63aa1ff9bc6a36ad076832610adfaaa.js 12.7 KiB new
8be3d8890c5fba754e08eb7eca041fd52c4e1cda.js 9.1 KiB new
09b656bd7a4481bbbe6e8eca67b9f946590279b6.js 8.6 KiB new
a72bfddde07afe02c6ec0fca22b2803e9f99743d.js 7.7 KiB new
a7cf6b93980fb0469fed525342bfa84b3a4fc396.js 7.0 KiB new

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

Entrypoint Eager size Budget Modules
✅ app 11.15 MiB (+768.8 KiB / +7.2%) report-only 1116
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 1023.6 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/puzzle.mjs 388.5 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/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/basketball-coach.mjs 337.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 + 60 modules 259.6 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/useProduct.ts + 18 modules 165.6 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).

turnipdabeets and others added 3 commits November 1, 2026 09:46
The tutorials stated 3.x versions whose PostHogConfig only has apiKey:, so the
projectToken: snippets would not compile. Also drop the CocoaPods and Carthage
pointers, since 4.x is Swift Package Manager only and those anchors are gone.
# Conflicts:
#	contents/tutorials/ios-ab-tests.md
… pages

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
turnipdabeets and others added 2 commits November 4, 2026 15:17
… guide

- Say a reverse proxy must serve /i/v1/* and pass Authorization (Bearer phc_...) through, linking the proxy reference checklist.
- Add $locale (device language with region) and the new $app_language, with setAppLanguage.
- Add captureAi with the MIGRATION.md example.
- Replace the didReceiveFeatureFlags observer snippet with a pointer to onFeatureFlags, since 4.0 removes the notification.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Nothing imports contents/docs/session-replay/_snippets/ios-installation.mdx, and it still documents screenshotMode, which 4.0 removes. The rendered iOS replay install page comes from the monorepo's docs/onboarding/session-replay/ios.tsx.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Android 4.0 guide edits the adjacent table row, so it now carries
both the Android and iOS "removed in 4.0.0" rows to avoid a conflict.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
turnipdabeets and others added 4 commits November 5, 2026 15:56
…erences

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Fold the CocoaPods read-only callout from #21884 into the install
snippet: 4.x is SPM-only, 3.x stays on CocoaPods until trunk goes
read-only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
#21808 marks the iOS and Android legacy options as removed in the same
table; editing the row here would conflict with it.

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 6, 2026
@turnipdabeets turnipdabeets changed the title docs(ios): add the 3.x to 4.0 upgrade guide docs(ios): posthog-ios 4.0 upgrade guide and screenshot-only mobile replay Nov 6, 2026
Comment thread contents/docs/libraries/ios/index.mdx Resolved
Comment thread contents/docs/libraries/ios/index.mdx Resolved
turnipdabeets and others added 2 commits November 10, 2026 15:29
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…n-profile drop

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread contents/docs/libraries/ios/index.mdx Resolved
Comment thread contents/docs/libraries/ios/index.mdx Resolved
turnipdabeets and others added 2 commits November 10, 2026 19:31
…setting

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…and 4.x install eval

- screenshotModeBackgroundCapture stays in 4.0 (posthog-ios#1052), so it's no
  longer listed with the removed replay options.
- Capture v1 now lives at /docs/api/capture-v1 (#21385).
- Push notifications example uses the <ph_project_token> placeholder.
- The web view masking rule applies to Android too.
- The install eval grades posthog-ios 4, the major the docs now show.
@turnipdabeets
turnipdabeets force-pushed the docs/ios-4-upgrade-guide branch from c12cf4e to a181eff Compare November 12, 2026 15:50
@eli-r-ph

Copy link
Copy Markdown
Contributor

#22061 lands before this PR. It deletes contents/docs/libraries/ios/index.mdx and ios/configuration.mdx, which this PR edits, and redirects the iOS pages to /docs/libraries/ios/reference. That page shows posthog-ios docs/getting-started.md (PostHog/posthog-ios#1061) as its "Getting started" section, so the new sections here need a home there or in MIGRATION.md. These links also need new targets:

  • contents/docs/integrate/_snippets/install-ios.mdx:7: /docs/libraries/ios#upgrading-from-version-3-to-version-4 → /docs/libraries/ios/migration
  • contents/docs/libraries/ios/index.mdx:199: /docs/libraries/ios/usage#ai-events → the "AI events" section of /docs/libraries/ios/migration (ios/usage is deleted too)

#22061 deletes libraries/ios/index.mdx and configuration.mdx and serves the
SDK's MIGRATION.md at /docs/libraries/ios/migration, which already covers the
upgrade, event options, captureAi and traits sections. Drop this PR's edits
to those pages and link the install snippet to the migration page.

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

Copy link
Copy Markdown
Contributor Author

Thanks! Dropped the edits to ios/index.mdx and configuration.mdx in 086cbcf. MIGRATION.md (with #1061) already covers those sections, and the install snippet now links /docs/libraries/ios/migration. The description now says this merges after #22061 and #21385.

turnipdabeets and others added 3 commits November 13, 2026 17:43
The hand-written iOS configuration page stays live until #22334 replaces it,
which waits for every mobile major. Rename maxRetries to
pushNotificationSubscriptionMaxRetries (it only ever limited push
subscription retries since 3.73), and say 4.0 removes evaluationEnvironments,
PostHogDataMode.cellular and propertiesSanitizer.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
posthog-ios#577 (released in 3.57.3) reads the Swift runtime message
from __crash_info, so the SIGTRAP limitation only applies to older SDKs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…hot-only claim

posthog-ios 4.0 keeps secure-entry fields masked inside a ph-no-mask
subtree. Kotlin Multiplatform still offers wireframe until its own
release, so "All SDKs" was too broad.

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

@ioannisj ioannisj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🤖 An AI agent wrote this on behalf of @ioannisj.

Nothing blocking: two nits (the (version 3) tab labels don't render, and the console-log snippet won't compile on 3.x) and a suggestion to document package traits. One more that I think fits better as a follow-up: 4.0 adds captureAi, but large events only shows it for Python and Node, so iOS users sending their own $ai_* events won't find it outside the migration guide.

```swift file=Package.swift
dependencies: [
.package(url: "https://github.com/PostHog/posthog-ios.git", from: "3.59.3")
.package(url: "https://github.com/PostHog/posthog-ios.git", from: "4.0.0")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🤖 An AI agent wrote this on behalf of @ioannisj.

[suggestion] 4.0 also adds package traits (SessionReplay, CrashReporting, Surveys, all on by default), and right now only MIGRATION.md mentions them. Worth a short note under this snippet showing traits: ["CrashReporting"] for anyone who wants to leave replay or surveys out of their binary? Fine as a follow-up too if you'd rather keep this PR to the pages 4.0 breaks.

@turnipdabeets turnipdabeets changed the title docs(ios): posthog-ios 4.0 upgrade guide and screenshot-only mobile replay docs(ios): posthog-ios 4.0 snippets and screenshot-only mobile replay Nov 20, 2026
@turnipdabeets
turnipdabeets marked this pull request as ready for review November 20, 2026 19:35
@turnipdabeets
turnipdabeets requested a review from a team November 20, 2026 19:35
@turnipdabeets
turnipdabeets merged commit d99711d into master Nov 20, 2026
26 checks passed
@turnipdabeets
turnipdabeets deleted the docs/ios-4-upgrade-guide branch November 20, 2026 19:35
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.

4 participants