Skip to content

docs: generate the Android SDK 3.x and experimental 4.x references - #940

Merged
gewenyu99 merged 17 commits into
markdown-reference-adapterfrom
markdown-reference-pages-3
Nov 11, 2026
Merged

gewenyu99 merged 17 commits into
markdown-reference-adapterfrom
markdown-reference-pages-3

Conversation

@gewenyu99

@gewenyu99 gewenyu99 commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

💡 Motivation and Context

We have a wave of breaking changes with new major versions for most SDKs. References are now read mostly by bots, not humans, and the HogRef format is heavy. Stacked on #939.

  • Commits references/posthog-android-3.md and the latest page, posthog-android-reference.md.
  • Commits posthog-android-4.md and posthog-android-migration.md, generated from chore/v4-remove-deprecated, the 4.0 branch in feat!: posthog-android 4.0 and posthog 7.0 #871. The getting-started and a few field docs need to land there before that page can be regenerated there.
  • posthog-android-migration.md is regenerated from docs/migration-3.x-to-4.0.md on chore/v4-remove-deprecated.

💚 How did you test it?

  • Every generated page compiles under posthog.com's MDX 1 check.

📝 Checklist

  • All commits are signed
  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Claude Code: Sonnet 5.5 built it and Opus 5.5 opened it, directed by Vincent. Not yet reviewed line by line.

End result

This is what we're building toward: the reference page on posthog.com, rendered from this PR's Markdown in a local posthog.com build with a local Strapi.

Android reference on posthog.com

Merge order

🤖 Generated with Claude Code

gewenyu99 and others added 2 commits November 4, 2026 19:55
Generated by bin/docs_scripts/generate_markdown.py.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Generated by bin/docs_scripts/generate_markdown.py --major 4 --experimental from feat/v4-capture-v1 (PRs #871 and #881), with the capability tags applied on top. Adds the 3.x to 4.0 migration guide page.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@gewenyu99 gewenyu99 self-assigned this Nov 5, 2026
@gewenyu99 gewenyu99 changed the title docs: generate the Android SDK 3.x reference docs: generate the Android SDK 3.x and experimental 4.x references Nov 5, 2026
gewenyu99 and others added 6 commits November 5, 2026 12:48
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The 4.x page and migration guide come from chore/v4-remove-deprecated (the 4.0
branch) with the capability tags and getting-started applied. Both still need to
land there.

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>
The 3.x pages lose only the blank line the stripped capability tags left behind. The 4.x page also
moves captureAi to Capture AI and onFeatureFlags to On feature flags, which the map's "next"
entries add.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@@ -0,0 +1,2569 @@
---
title: "PostHog Android SDK 4.x (experimental)"

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.

[suggestion] Once this is on main, the daily sync publishes it and posthog-android-migration.md on posthog.com while 4.0 is still unreleased. Nothing regenerates them until the 4.0 release, and they're already behind the v4 branch (e.g. the remoteConfig removal). Could we drop both from this PR and generate them on #871's branch once #939 is merged into it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, those pages on posthog.com don't go live yet. The pages are going to go up first unindexed, and not in navigation. And we won't merge these PRs either until the SDK is actually released.

gewenyu99 and others added 4 commits November 5, 2026 14:55
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>
Comment thread references/posthog-android-migration.md Outdated
If you identify users with a long ID, such as a JWT or a long email address, shorten or hash it before you upgrade. Otherwise every event for that user is dropped.
`identify()` with an empty or whitespace-only distinct ID is still ignored, as in 3.x.

## SDK identity

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.

[suggestion] This page is behind docs/migration-3.x-to-4.0.md on chore/v4-remove-deprecated: the branch dropped this SDK identity section (#942 keeps $lib in properties) and added the custom httpClient paragraph, which is missing here. Could we regenerate from the current branch, or once #871 merges?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, I'll regenerate now from that branch, and again once it merges. It also regenerates on every release, so any minor drift gets picked up then. Thanks!

gewenyu99 and others added 5 commits November 6, 2026 16:42
Rebuilt from docs/migration-3.x-to-4.0.md on chore/v4-remove-deprecated,
which dropped the SDK identity section (#942) and added the custom
httpClient paragraph.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Rebuilt from docs/migration-3.x-to-4.0.md on chore/v4-remove-deprecated,
which now covers the missing-flag response, posthog-server 2.25 and retry scope.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Picks up the branch's feature flag doc comment fixes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@gewenyu99
gewenyu99 marked this pull request as ready for review November 10, 2026 19:36
@gewenyu99
gewenyu99 requested a review from a team as a code owner November 10, 2026 19:36
@gewenyu99
gewenyu99 requested review from eli-r-ph and turnipdabeets and removed request for a team November 10, 2026 19:36
@veria-ai

veria-ai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

PR overview

No security issues were found in this pull request.

Reviews

@gewenyu99
gewenyu99 added this pull request to stack #969 November 11, 2026 18:56
@gewenyu99
gewenyu99 merged commit d753954 into main Nov 11, 2026
15 checks passed
@gewenyu99
gewenyu99 deleted the markdown-reference-pages-3 branch November 11, 2026 18:59
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.

2 participants