Skip to content

docs: generate the iOS SDK 3.x and experimental 4.x references - #1032

Merged
gewenyu99 merged 16 commits into
feat/markdown-reference-adapterfrom
feat/markdown-reference-3
Nov 11, 2026
Merged

gewenyu99 merged 16 commits into
feat/markdown-reference-adapterfrom
feat/markdown-reference-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 #1030.

  • Commits references/posthog-ios-3.md and the latest page, posthog-ios-reference.md.
  • Commits posthog-ios-4.md and posthog-ios-migration.md, generated from chore/v4-remove-deprecated, the 4.0 branch in chore!: iOS Major Release 4.0 #873. The Swift Package Manager getting-started needs to land there before that page can be regenerated there.
  • posthog-ios-migration.md is regenerated from MIGRATION.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.

iOS reference on posthog.com

Merge order

🤖 Generated with Claude Code

gewenyu99 and others added 2 commits November 4, 2026 19:55
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@gewenyu99 gewenyu99 self-assigned this Nov 5, 2026
@gewenyu99
gewenyu99 changed the base branch from feat/markdown-reference-tags to feat/markdown-reference-adapter November 5, 2026 16:43
@gewenyu99 gewenyu99 changed the title docs: generate the iOS SDK 3.x reference docs: generate the iOS SDK 3.x and experimental 4.x references Nov 5, 2026
gewenyu99 and others added 2 commits November 5, 2026 12:25
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>

@turnipdabeets turnipdabeets 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.

[suggestion] posthog-ios-4.md still says to install with CocoaPods, which 4.0 drops, so it needs regenerating once getting-started is fixed in #1030.

[nit] posthog-ios-3.md and posthog-ios-reference.md are identical apart from the title. Is that what the Strapi sync expects?

gewenyu99 and others added 6 commits November 5, 2026 14:30
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…symbols

3.x and 4.x now mark deprecated APIs and give same-titled overloads one heading.
4.x drops the Swift-obsoleted ObjC bridges, lists captureAi, alias(_:options:) and
isFeatureEnabled(_:defaultValue:) under their capabilities, and installs with
Swift Package Manager only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The pages match the tag-based run, minus six empty Discussion headings that a
discussion holding only the tag line left behind.

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>
@turnipdabeets turnipdabeets mentioned this pull request Nov 5, 2026
6 of 18 tasks
@gewenyu99

Copy link
Copy Markdown
Contributor Author

posthog-ios-reference is always the current latest, and each version renders as its own page. When 5.0 ships, posthog-ios-4 stays verbatim, posthog-ios-reference moves to 5, and posthog-ios-5 is added. So there's always a latest plus the versioned pages. That's what Strapi expects.

Good catch on CocoaPods. It's dropped in 4.0 and the getting started is rewritten.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread references/posthog-ios-migration.md Outdated
The distinct ID can come from `identify(_:)`, the `distinctId` argument of `capture` or `beforeSend`.
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.

### 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 MIGRATION.md on chore/v4-remove-deprecated: the branch dropped this SDK identity section (#1036 keeps $lib in properties) and added the isFeatureEnabled empty-variant note, which is missing here. Could we regenerate from the current branch, or once #873 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, we'll regenerate once that merges, but I'll go ahead and regenerate now from that branch. 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:41
Rebuilt from MIGRATION.md on chore/v4-remove-deprecated, which dropped the
SDK identity section (#1036) and added the isFeatureEnabled empty-variant note.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Rebuilt from MIGRATION.md on chore/v4-remove-deprecated after its
pre-release review fixes.

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
@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 #1057 November 11, 2026 18:56
@gewenyu99
gewenyu99 merged commit 808e861 into main Nov 11, 2026
43 checks passed
@gewenyu99
gewenyu99 deleted the feat/markdown-reference-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