Skip to content

[Waiting on mobile SDK releases] feat(docs): replace the mobile SDK pages with their Markdown references - #22334

Draft
gewenyu99 wants to merge 9 commits into
eli/capture-v1-api-referencefrom
sdk-markdown-reference-mobile
Draft

gewenyu99 wants to merge 9 commits into
eli/capture-v1-api-referencefrom
sdk-markdown-reference-mobile

Conversation

@gewenyu99

@gewenyu99 gewenyu99 commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Changes

This PR moves the iOS, Android, Flutter, and React Native docs to their Markdown reference pages. It holds the mobile part of #22061, so #22061 can land before the mobile majors ship. Merge it after posthog-ios 4.0.0, posthog-android 4.0.0, posthog_flutter 6.0.0, and posthog-react-native 5.0.0 publish their references.

  • Pages. It deletes the iOS index, usage, and configuration pages, and the Android, Flutter, and React Native index pages.
  • Nav. Each mobile SDK gets its reference page, one entry for each major, and its migration guide.
  • Redirects. The deleted pages and the posthog-react-native HogRef pages redirect to /docs/libraries/<sdk>/reference. Old redirects to the mobile pages now go to the reference pages.
  • Links. Links to headings on the deleted pages go to the matching reference or docs heading.
  • React Native iOS steps. The CocoaPods, hybrid, and full Swift Package Manager steps move into the error tracking React Native page, because no other page has them.

Screenshots of the nav come before this PR leaves draft.

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

🤖 Generated with Claude Code


Update: the build publishes the mobile references, and the web SDK stays as it is on master

  • Build. This PR adds posthog-ios, posthog-android, posthog-flutter, and posthog-react-native to PUBLISHED_SDK_REFERENCES, so the build writes their pages when this PR merges. Before this PR merges, the build skips them.
  • Web SDK. The web SDK docs stay hand-written. This PR has no posthog-js redirects and no links to /docs/libraries/js/reference.

Not tested: a local build of this PR.

Move iOS, Android, Flutter, and React Native to their reference pages:
nav entries, redirects, links, and the React Native iOS dependency
steps, which move into the error tracking React Native page.

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

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🔴 Failed View logs Nov 16, 2026 10:33PM

Push a fix or re-run the workflow to try again.

Common culprits
  • MDX issues - unescaped </> characters, unclosed tags, or malformed JSX
  • External API timeouts - GitHub, Strapi, or Ashby occasionally hiccup

@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 33 errors, 203 warnings, 19 suggestions in your markdown

Full report → · Copy the Job Summary code block into an LLM to batch-fix issues.

Note: Too many findings to show inline. See the Job Summary linked above.

File Errors Warnings Suggestions
contents/docs/_snippets/identify-intro.mdx 1 0 0
contents/docs/_snippets/react-native-cocoapods-notice.mdx 1 0 0
contents/docs/error-tracking/installation/react-native.mdx 0 6 0
contents/docs/error-tracking/upload-source-maps/react-native.mdx 5 21 0
contents/docs/integrate/send-events/_snippets/send-events-android.mdx 7 2 2
contents/docs/integrate/send-events/_snippets/send-events-flutter.mdx 0 12 4
contents/docs/libraries/ios/_snippets/autocapture.mdx 0 10 4
contents/docs/logs/installation/android.mdx 0 2 0
contents/docs/privacy/_snippets/autocapture-react-native.mdx 8 1 3
contents/docs/product-analytics/_snippets/how-to-capture-anonymous-events-android.mdx 3 0 0
contents/docs/product-analytics/_snippets/how-to-capture-anonymous-events-flutter.mdx 3 0 0
contents/docs/product-analytics/_snippets/how-to-capture-anonymous-events-ios.mdx 3 0 0
contents/docs/product-analytics/_snippets/how-to-capture-identified-events-android.mdx 0 0 1
contents/docs/product-analytics/_snippets/how-to-capture-identified-events-flutter.mdx 0 0 1
contents/docs/product-analytics/_snippets/how-to-capture-identified-events-ios.mdx 0 0 1
contents/docs/product-analytics/autocapture.mdx 0 37 3
contents/docs/product-analytics/installation/ios.mdx 0 2 0
contents/docs/session-replay/_snippets/flutter-installation.mdx 0 14 0
contents/docs/session-replay/installation/react-native.mdx 1 3 0
contents/docs/surveys/_snippets/flutter-surveys-installation.mdx 0 10 0
contents/docs/surveys/installation/flutter.mdx 0 2 0
contents/docs/workflows/configure-channels.mdx 1 17 0
contents/tutorials/android-ab-tests.md 0 4 0
contents/tutorials/android-analytics.md 0 11 0
contents/tutorials/android-feature-flags.md 0 4 0
contents/tutorials/flutter-ab-tests.md 0 3 0
contents/tutorials/flutter-analytics.md 0 7 0
contents/tutorials/flutter-feature-flags.md 0 5 0
contents/tutorials/ios-ab-tests.md 0 8 0
contents/tutorials/ios-analytics.md 0 6 0
contents/tutorials/ios-feature-flags.md 0 6 0
contents/tutorials/ios-session-replay.md 0 9 0
contents/tutorials/react-native-ab-tests.md 0 1 0

@gewenyu99
gewenyu99 changed the base branch from sdk-markdown-reference-js-nav to eli/capture-v1-api-reference November 13, 2026 17:17
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

12.06 MiB (-16.0 KiB / -0.1%)

Largest changed named chunks
Chunk Gzip Δ vs master
d53be7e4323c811b7b208da3a1f00becabbdd275.js 439.3 KiB -16.2 KiB / -3.6%

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

Entrypoint Eager size Budget Modules
✅ app 10.41 MiB (+0.5 KiB / +0.0%) report-only 1100
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 1022.3 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 258.5 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 + 24 modules 155.6 KiB
./src/hooks/useProduct.ts + 9 modules 149.4 KiB
./src/navs/index.js 147.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 added a commit that referenced this pull request Nov 13, 2026
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>
turnipdabeets added a commit that referenced this pull request Nov 16, 2026
#22334, which replaces this page with the generated 4.x reference, waits
for every mobile SDK major. Until then this page ships on its own, so
move its snippets to projectToken and pushNotificationSubscriptionMaxRetries,
drop the removed onFeatureFlags and drawable conversion options, note the
evaluationEnvironments removal and the 4.0 surveys default, and link the
migration guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
gewenyu99 and others added 6 commits November 16, 2026 13:53
# Conflicts:
#	contents/docs/_snippets/identify-intro.mdx
#	contents/docs/libraries/react-native/index.mdx
#	gatsby-config.js
#	src/navs/activeMenu.test.ts
#	vercel.json
This PR replaces the hand-written iOS, Android, Flutter, and React Native
pages, so the build must write their reference pages. The web SDK docs
stay hand-written, so the build still skips posthog-js.

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

This branch has not been deployed

No deployments
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.

1 participant