Skip to content

[Waiting on posthog-react-native 5.0.0] feat(docs): replace the React Native SDK pages with their Markdown reference - #22334

Draft
gewenyu99 wants to merge 190 commits into
masterfrom
sdk-markdown-reference-mobile
Draft

gewenyu99 wants to merge 190 commits into
masterfrom
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.


Update: this PR holds React Native only

The iOS, Android, and Flutter parts moved to their own PRs, so each SDK can merge after its own release:

This PR merges after posthog-react-native 5.0.0 publishes its references.

eli-r-ph and others added 30 commits November 1, 2026 12:48
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…es and non-string ids are new

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

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

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

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

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(libraries): add the capture v1 SDK upgrade guide

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

* docs(libraries): note the distinct ID limit and group identify IDs on capture v1

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

* docs(libraries): call the $ settings properties legacy option properties

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

* docs(libraries): drop product_tour_id from the options table

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

* docs(libraries): add a limits section to the capture v1 upgrade guide

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

* docs(libraries): before_send must keep distinct_id a string

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

* docs(capture-v1): note that tracing headers are opt-in for Go and Python

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

* docs(capture-v1): drop the tracing header note; v1 keeps reading them by default

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

* docs(capture-v1): repeated uuids keep the first event

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

* docs(capture-v1): duplicate uuid note now waits only on SDK support

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

* docs(capture-v1): SDKs report dropped duplicate copies; mark 404/429 retries as undecided

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

* docs(capture-v1): reword the retry TODO comment

* docs(capture-v1): Go nested modules move to /v2; link the iOS 4.0 guide

* docs: list feature flag properties with the values the SDK adds

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

* docs: list trace IDs with the SDK values and the GeoIP default per SDK

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

* docs(capture-v1): SDKs follow only same-origin 307 and 308 redirects

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

* docs(sdks): list product_tour_id in the capture v1 option table

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

* docs(sdks): list the historical migration setting for capture v1 SDKs

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

* docs(sdks): resolve capture v1 SDK guide TODOs, add Android and Node details

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

* docs(sdks): proxy checklist for capture v1 headers; link the fixed proxy guides

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

* docs(sdks): proxies must accept 20MB requests for capture v1

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

* docs(capture-v1): sdks retry 404 and 429

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

* docs(libraries): drop the checked AI property names note

* docs(libraries): scope the $set merge and group rules to the SDKs that follow them

* docs(libraries): say which Authorization values a proxy must keep

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

* docs(libraries): keep every PostHog key type in the proxy note

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

* docs(libraries): ask users to check before_send hooks for the v1 event shape

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

* docs(capture-v1): fix sdk upgrade page links, scope, and settings

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

* docs(capture-v1): sdks always write three timestamp digits

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

* docs(capture-v1): node drops a non-string hook distinct id too

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

* docs: link capture v1 from capture, data, AI, and SDK pages (#21387)

* docs: link capture v1 from the capture, data, AI, and SDK pages

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

* docs: note that capture v1 drops long distinct IDs instead of shortening them

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

* docs: separate the SDK page callouts from their TODO comments so MDX parses

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

* docs(data): describe capture v1 duplicate uuid handling as keep-first, drop-rest

* docs(migrate): link capture v1 for historical migrations

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

* docs: capture v1 paths for self-hosted proxies and upgrades; v1 AI needs no $ai_model

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

* docs(self-host): v1 sdks retry 404 before dropping

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

* docs: fix the Flutter capture v1 platforms and drop the checked warning titles note

* docs(capture-v1): add android callout and fix cross-link wording

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

* docs(data): disable_skew_correction still clamps far-future timestamps

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

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
…ippets

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
gewenyu99 and others added 21 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>
…versions as 8.x.x and 8.0.0

The capture v1 table on "Choosing a PostHog SDK" linked the Node.js
migration guide on GitHub. It now links /docs/libraries/node/migration,
like the other SDKs, and each SDK name links its reference page.

Version numbers now use the 8.x.x and 8.0.0 form, which the migration
page titles also use.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
# Conflicts:
#	contents/docs/product-analytics/identify.mdx
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-api-reference

One conflict, in mcp-analytics/installation/typescript.mdx: keeps master's
note on the default tool arguments (#22354) under the options table, then
this branch's Event options section.
posthog-node 6.0 reads only beforeSend (posthog-js #5757), so the Node.js
before_send examples would be silently ignored. The error tracking capture
page and the before-send snippet now show beforeSend for Node.js with a
Node example; the React email page installs posthog-node@6; the capture v1
types note names both hook spellings.
…tion filter key

- Rewrite the en-dash connectors this PR added as sentences, commas or colons.
- Name the minimum versions for event options: @posthog/ai 8.21.0 and
  @posthog/mcp 1.3.0 (their pending minor changesets on capture-v1).
- The web and React Native before-send examples filtered on
  exception["$exception_type"], which no SDK sets on $exception_list entries;
  posthog-js core's ErrorPropertiesBuilder sets `type`, so the filter never
  matched. They now check `type`, as the Node.js example does.
…list

This PR replaces those four SDK pages with generated references, which are
not MDX, so the SDK list on the Integrate page lost them. They are listed
explicitly with their references, as LibraryComparison already does.
This PR redirects the Node.js, Python, Go and Rust landing pages to their
generated references, so a build that warns past a failed Strapi fetch
would deploy 404s for those SDKs. The fetch now retries twice, and
`gatsby build` fails (reporter.panicOnBuild) when it still fails or when a
published SDK has no reference.md; `gatsby develop` only logs. On Vercel a
failed build keeps the previous deployment live.
Base automatically changed from eli/capture-v1-api-reference to master November 17, 2026 19:52
gewenyu99 and others added 3 commits November 17, 2026 18:37
Keeps this branch's delete of contents/docs/libraries/react-native/index.mdx; the React Native reference has the setAppLanguage section #22285 added there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Conflicts in gatsby-config.js, gatsby/sdkMarkdownReferences.js, src/components/LibraryComparison/index.tsx, src/navs/activeMenu.test.ts and vercel.json: keep this branch's mobile and React Native additions next to master's server SDK lines. Restore `const client` in LibraryComparison, which the earlier merge 1aa8a8f dropped while the mobile rows still use it, so the build no longer fails with "ReferenceError: client is not defined".

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

These pages moved to their own PRs: sdk-markdown-reference-ios, sdk-markdown-reference-android, and sdk-markdown-reference-flutter. This PR keeps React Native only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@gewenyu99 gewenyu99 changed the title [Waiting on mobile SDK releases] feat(docs): replace the mobile SDK pages with their Markdown references [Waiting on posthog-react-native 5.0.0] feat(docs): replace the React Native SDK pages with their Markdown reference Nov 18, 2026
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.

3 participants