Skip to content

docs: generate the experimental Android SDK 4.x reference - #941

Closed
gewenyu99 wants to merge 1 commit into
markdown-reference-pages-3from
markdown-reference-pages-4
Closed

gewenyu99 wants to merge 1 commit into
markdown-reference-pages-3from
markdown-reference-pages-4

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. This is part of the stack below.

  • Commits posthog-android-4.md and posthog-android-migration.md, generated from feat/v4-capture-v1.
  • The capability tags need to land on that branch before the page can be regenerated there.

💚 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.

Merge order

🤖 Generated with Claude Code

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

@posthog posthog Bot 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.

PostHog Review · Standard · reviewed 87ea09b: 1 Should fix.

This is the only automatic review while this pull request is a draft. Comment @posthog review to review new changes sooner. Otherwise, a review of the new changes runs when you mark it ready for review.

See this review and its findings in PostHog Review. Comment @posthog review --deep for a Deep review. A Deep review takes longer and looks deeper than a Standard review.

)
```

- `captureAi` returns the event's uuid, or `null` when the event isn't queued: the SDK is disabled or opted out, the event name is empty, `beforeSend` dropped it, or it's over the size limit. Once 100 AI events (`captureAiMaxQueueSize`) or 50 MiB are queued, including events still waiting to be written to disk during a slow upload, the oldest are dropped.

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.

P2 · Document separate AI queue limits for pending events and disk files

During a slow upload with a disk backlog, PostHogQueue.addMeasured() limits pending events independently of the files limited by removeRecordSync(). Each tier retains up to 100 events or 50 MiB, and each evicts its own oldest events. This sentence understates the total retained backlog and promises combined eviction; document the two independent limits.

@gewenyu99

Copy link
Copy Markdown
Contributor Author

Folded into #940, so each SDK is two PRs: the code, then the generated pages.

@gewenyu99 gewenyu99 closed this Nov 5, 2026
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