Skip to content

docs: mobile SDK push notifications (iOS + Android) - #19062

Draft
dmarchuk wants to merge 1 commit into
masterfrom
push-client-library-docs
Draft

docs: mobile SDK push notifications (iOS + Android)#19062
dmarchuk wants to merge 1 commit into
masterfrom
push-client-library-docs

Conversation

@dmarchuk

Copy link
Copy Markdown
Contributor

What

Client-library (mobile SDK) docs for Workflows push notifications, based on the SDK PRs:

  • iOS — new page docs/libraries/ios/push-notifications.mdx (+ nav entry). Covers automatic vs manual device-token registration, unregister/reset(), $push_notification_opened open tracking, and the pushIdentityProvider identity-verification hook. Grounded in posthog-ios #729 (merged, base push) and posthog-ios #735 (open, identity token).
  • Android — new "Push notifications" section in docs/libraries/android/index.mdx. Registration (auto via FCM + onNewToken forwarding, and manual), unregister/reset(), open tracking. Grounded in posthog-android #642 (merged). Notes identity verification is iOS-only for now (no Android identity PR yet).

Pairs with the Workflows-side channel docs in #19037 (this covers the SDK/device side; that covers connecting the channel + identity modes).

Draft — do not merge yet

  • The iOS identity verification section documents posthog-ios #735, which is still open. Confirm the final API and the SDK version that ships it before merging, and add the version note.
  • React Native and Flutter have no push support yet — intentionally not documented.
  • Verify the exact method signatures/config names against the released SDK versions once they're cut.

🤖 Generated with Claude Code

@github-actions github-actions Bot added the docs Improvements or additions to product documentation, "Docs" label Jul 29, 2026
@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Jul 29, 2026 11:49AM

@github-actions

Copy link
Copy Markdown
Contributor

Vale prose linter → found 7 errors, 57 warnings, 11 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/android/index.mdx — 2 errors, 43 warnings, 8 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 'Android' instead of 'android'. Vale.Terms
7:15 warning Use 'Android' instead of 'android'. Vale.Terms
111:163 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
111:201 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
126:106 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
155:49 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
157:66 suggestion Address the reader directly. Use 'you' instead of 'the User'. PostHogDocs.DirectAddress
157:131 suggestion Address the reader directly. Use 'you' instead of 'the User'. PostHogDocs.DirectAddress
159:5 warning 'Removing stored Super Properties' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
171:69 warning Avoid trivializing words. 'simply' can sound dismissive to the reader. PostHogDocs.Trivializers
239:10 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
239:94 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
239:103 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
287:8 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
287:55 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
287:128 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
297:28 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
297:54 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
331:4 warning 'Error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
331:4 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
333:11 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
333:52 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
337:12 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
337:125 warning Use 'ID' instead of 'id'. Vale.Terms
341:4 warning 'Session replay' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
341:4 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
343:12 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
343:74 warning Avoid trivializing words. 'all you need to do' can sound dismissive to the reader. PostHogDocs.Trivializers
347:11 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
360:62 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
360:93 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
360:117 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
360:132 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
362:130 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
422:43 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
422:51 warning 'Logcat' is a possible misspelling. PostHogBase.Spelling
435:75 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
443:83 warning 'deduplicating' is a possible misspelling. PostHogBase.Spelling
444:44 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
445:69 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
446:53 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
452:39 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
453:93 warning 'Logcat' is a possible misspelling. PostHogBase.Spelling
454:56 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
455:71 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
455:208 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
501:72 warning 'classpath' is a possible misspelling. PostHogBase.Spelling
511:95 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
531:37 warning 'unregisters' is a possible misspelling. PostHogBase.Spelling
535:139 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
537:3 warning 'FAQ' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
contents/docs/libraries/ios/push-notifications.mdx — 5 errors, 14 warnings, 3 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
10:154 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
14:164 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
20:192 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
21:28 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
21:79 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
21:98 warning Use 'ID' instead of 'id'. Vale.Terms
35:174 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
53:1 warning 'Unregister' is a possible misspelling. PostHogBase.Spelling
59:52 warning 'unregisters' is a possible misspelling. PostHogBase.Spelling
84:43 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
84:51 warning Use 'iOS' instead of 'ios'. Vale.Terms
84:96 warning Use 'iOS' instead of 'ios'. Vale.Terms
84:110 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
90:35 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
90:128 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
108:83 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
109:47 warning 'APNs' is a possible misspelling. PostHogBase.Spelling
109:120 warning Use 'ID' instead of 'id'. Vale.Terms
110:115 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash

@github-actions

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

7.07 MiB (+0.0 KiB / +0.0%)

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

Entrypoint Eager size Budget Modules
app 16.30 MiB (+0.1 KiB / +0.0%) report-only 2000
Largest modules in the app closure
Module Size
./src/data/mcp-tools.json 915.4 KiB
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 743.9 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js 481.4 KiB
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules 395.1 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.cjs.js 364.8 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
./src/hooks/useCustomers.tsx + 54 modules 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
./src/components/ProductComparisonTable/index.tsx + 121 modules 282.8 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 272.1 KiB
./node_modules/.pnpm/framer-motion@10.18.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/framer-motion/dist/es/render/dom/motion.mjs + 109 modules 253.9 KiB
./node_modules/.pnpm/d3@7.9.0/node_modules/d3/src/index.js + 208 modules 247.4 KiB
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules 240.1 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).

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.

1 participant