Repository navigation
docs(flutter): update install docs and tutorials for posthog_flutter 6.0 - #20924
turnipdabeets wants to merge 43 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Deploy preview
Changed pages
|
|
Vale prose linter → found 0 errors, 67 warnings, 0 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 3:116 | warning | 'podspec' is a possible misspelling. | PostHogBase.Spelling |
| 5:23 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 5:50 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 5:115 | warning | Use 'X' instead of 'x'. | Vale.Terms |
contents/docs/feature-flags/cutting-costs.mdx — 0 errors, 23 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 21:1 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 21:102 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 23:30 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 26:63 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 37:1 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 61:127 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 65:118 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 67:96 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 69:99 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 69:195 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 69:240 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 69:275 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 75:17 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 75:95 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 75:115 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 94:36 | warning | 'ETags' is a possible misspelling. | PostHogBase.Spelling |
| 94:151 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 106:107 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 258:214 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 258:229 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 258:249 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 274:42 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 274:69 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
contents/docs/integrate/_snippets/install-flutter.mdx — 0 errors, 1 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 132:6 | warning | 'Dart setup (For manual step only)' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
contents/docs/integrate/feature-flags-code/_snippets/feature-flags-code-flutter.mdx — 0 errors, 7 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 1:13 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 13:18 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 27:83 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 29:39 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 49:91 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 51:15 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 53:91 | warning | 'refetch' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/logs/installation/flutter.mdx — 0 errors, 5 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 65:52 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 98:86 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 141:30 | warning | Use 'ID' instead of 'id'. | Vale.Terms |
| 147:6 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 160:507 | warning | Use 'X' instead of 'x'. | Vale.Terms |
contents/docs/session-replay/_snippets/flutter-installation.mdx — 0 errors, 14 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 3:3 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 10:20 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 16:48 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 45:36 | warning | Use descriptive link text instead of '[this page]'. | PostHogBase.DescriptiveLinkText |
| 73:19 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 92:14 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 96:4 | warning | 'Limitations for mobile session replay' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 96:27 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 103:4 | warning | 'Limitations for Flutter Web session replay' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 103:32 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 113:35 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 114:40 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 115:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 117:7 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
contents/docs/surveys/installation/flutter.mdx — 0 errors, 2 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 13:64 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 30:11 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/flutter-ab-tests.md — 0 errors, 1 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 336:18 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/flutter-analytics.md — 0 errors, 5 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 19:2 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 324:138 | warning | Use 'PostHog' instead of 'Posthog'. | Vale.Terms |
| 409:23 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 450:18 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 472:18 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/flutter-feature-flags.md — 0 errors, 3 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 2:22 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 16:2 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 202:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/flutter-remote-config.md — 0 errors, 2 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 168:15 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 324:4 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
Bundle reportTotal JS (gzip)12.22 MiB (+0.4 KiB / +0.0%) Eager graph (modules shipped in each entrypoint's initial chunks)
Largest modules in the
|
| 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 |
1023.1 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/puzzle.mjs |
388.5 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/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/basketball-coach.mjs |
337.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 + 60 modules |
259.4 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/useProduct.ts + 18 modules |
166.5 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).
|
This PR hasn't seen activity in two weeks! Should it be merged, closed, or further worked on? If you want to keep it open, please remove the |
|
Flutter 6 sends events from iOS, macOS, Android, Windows and Linux to capture v1. Could the upgrade guide say so in one section, list what a reverse proxy must forward (/i/v1/analytics/events, /i/v1/ai/events and the Authorization header), and link the posthog-ios and posthog-android 4.0 migration guides? |
|
One addition for the proxy section: the proxy also needs to pass every PostHog-* header through and accept request bodies up to 20 MB (nginx and ingress-nginx default to 1 MB). The server SDK guides use this checklist: https://github.com/PostHog/posthog-python/blob/235047e220c48e1a69ab7354564ceefe035c4b34/docs/migration-7.x-to-8.0.md#L44-L50 |
|
@eli-r-ph I added the capture v1 parts to the Flutter 6 upgrade guide (3284e0f): endpoints per platform (web stays on posthog-js), reverse proxy and self-hosted requirements, property precedence, per-event |
There was a problem hiding this comment.
PostHog Review · Standard · reviewed 3284e0f: 5 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.
…, native addBeforeSend, phx_ keys everywhere
|
@turnipdabeets thanks, the capture v1 parts read well. A few additions for the 6.0 guide:
|
Add Event options and Capturing AI events sections to the Flutter page, with the captureAi queue settings and their defaults. The version 6 upgrade guide now covers what changed and links to them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add onFeatureFlags, synchronous beforeSend, the Windows and Linux changes from 5.x and the proxy Authorization rule. Link the managed proxy page, list Windows and Linux as supported, and mark AI observability as supported. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@eli-r-ph thanks, these are in now (00c3ba4, plus 0294168 for the AI queue defaults):
The guide's |
posthog-flutter keeps the call queue on iOS, macOS and Android, so the event isn't dropped. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
gewenyu99
left a comment
There was a problem hiding this comment.
will stamp and re-review once release is out. Comment from bot
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…upgrade checklist in the v6 guide Add registerOptions()/unregisterOptions() to event options, super properties and the platform interface list, the $lib pair exception, the missing-flag $feature_flag_response and null changes on iOS, macOS and Android, the posthog-server binary compatibility note, debug log text, close() timing on Windows and Linux, and an upgrade checklist. Point the Android guide link at MIGRATION.md. Claude-Session: https://claude.ai/code/session_019xLynttdFZAHfqTem5BhPQ
|
The description's 'Not in this PR' list is out of date. The PR now edits the session replay snippet and deletes the surveys snippet, in-app onboarding moved to PostHog/posthog#128557, and the AI events section comes from #21963. |
…entify events Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ess setting Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@eli-r-ph Updated the description: it now lists the session replay snippet, the deleted surveys snippet, PostHog/posthog#128557 and #21963. |
Web beforeSend now sees $current_url, $host and $pathname (posthog-flutter#714). Add the rolling-back-to-5.x notes from MIGRATION.md, and macOS 11.0 to the install snippets. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…personless Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
#22061 lands before this PR. It deletes
|
The upgrade guide now lives at /docs/libraries/flutter/migration (#21385), so restore flutter/index.mdx to master, point the CocoaPods notice at the migration guide, and scope the synchronous logs beforeSend rule to 6.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ery platform Flutter 3.50.0 stable ships flutter/flutter#184590, so iOS add-to-app modules install plugins through SPM there. The tutorials now say the Flutter 3.41 floor applies on every platform, not just iOS. Drops the debouncerDelay note (6.0 removes it) and a doubled "in Xcode". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Once these docs pin ^6.0.0, the 5.x `install` rubric fails by design. Promote `install-next` to `install` and drop the 5.x one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Important
Hold until posthog_flutter 6.0 is released. Several pages describe 6.0 requirements (iOS 15, Xcode 26,
PROJECT_TOKENonly), which are wrong for 5.x users until then.Depends on:
posthog_flutter.podspec, which the SPM-only text relies on./docs/libraries/flutter/migrationfrom posthog-flutter'sMIGRATION.md, which the CocoaPods notice links, and deletes/docs/libraries/flutter(flutter/index.mdx), which still showsenable()/disable(). The page content comes from docs: sort the Flutter 6.0.0 migration guide by when you make each change posthog-flutter#726./docs/api/capture-v1, which the migration guide linkssurveys/_snippets/flutter-surveys-installation.mdx, which this PR deletes. Keep the deletion; nothing imports the file. (docs(android): posthog-android 4.0 upgrade guide and replay docs #21808 no longer conflicts.)Changes
CocoaPods is removed in 6.0. Swift Package Manager becomes the only iOS and macOS option, with Flutter 3.41 or later. iOS add-to-app modules need Flutter 3.50 or later (flutter/flutter#184590 shipped in 3.50.0 stable), or stay on 5.x. The install snippets, surveys page and tutorials all say so.
Upgrade guide: the 5 → 6 upgrade guide lives at
/docs/libraries/flutter/migration, generated from posthog-flutter'sposthog_flutter/MIGRATION.mdand published by #22334. This PR doesn't touch/docs/libraries/flutter(flutter/index.mdx), which #22334 deletes.Docs for posthog_flutter 6.0.
pubspec.yamlstep; the iOS step says how to turn on SPM on Flutter 3.41 to 3.43.com.posthog.posthog.API_KEY→PROJECT_TOKEN. 6.0 no longer readsAPI_KEY, whilePROJECT_TOKENalready works on 5.x.minSdkVersion21 → 23. posthog-android already requires 23.feature-flags-code-flutter.mdx, shown on/docs/feature-flags/adding-feature-flag-code): usesPosthog().onFeatureFlags((loaded) { ... })beforesetup(), with a note for 5.x readers to keepconfig.onFeatureFlags.flutter-cocoapods-notice.mdx): says 6.0 is SPM-only with no podspec, that apps that can't use SPM stay on 5.x, and links the migration guide.PostHogLogsConfig.beforeSendcallbacks must be synchronous in 6.0 and later; 5.x also accepts asynchronous callbacks.surveys/_snippets/flutter-surveys-installation.mdx, which nothing imported.product-analytics/installation/flutter.eval.yaml):install-next(posthog_flutter 6 rubric) becomesinstall, replacing the 5.x rubric that fails once the snippets pin^6.0.0.debouncerDelaycomment; 6.0 removes that setter.sendFeatureFlagEventinstead ofsendFeatureFlagEvents, which 6.0 removes.Every claim was checked against the 6.0 branches and posthog-ios 4.0. Vale reports no alerts on the changed lines, apart from "Podfile" flagged as a misspelling on lines that already used the word.
Not in this PR:
posthog_flutter/MIGRATION.mdin posthog-flutter, published through [Waiting on mobile SDK releases] feat(docs): replace the mobile SDK pages with their Markdown references #22334.Checklist
vercel.json🤖 Generated with Claude Code