Repository navigation
[Waiting on posthog-ios 4.0.0] feat(docs): replace the iOS SDK pages with their Markdown reference - #22515
Draft
gewenyu99 wants to merge 2 commits into
Draft
[Waiting on posthog-ios 4.0.0] feat(docs): replace the iOS SDK pages with their Markdown reference#22515gewenyu99 wants to merge 2 commits into
gewenyu99 wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Vale prose linter → found 4 errors, 94 warnings, 12 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 |
|---|---|---|---|
| 5:179 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
contents/docs/integrate/_snippets/install-ios.mdx — 0 errors, 4 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 2:11 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 7:5 | warning | 'CocoaPods' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 13:5 | warning | 'Swift Package Manager' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 39:33 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/integrate/send-events/_snippets/send-events-flutter.mdx — 0 errors, 12 warnings, 4 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 32:19 | warning | 'Backgrounded' is a possible misspelling. | PostHogBase.Spelling |
| 32:78 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 35:24 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 37:29 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 37:90 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 38:8 | warning | 'rageclick' is a possible misspelling. | PostHogBase.Spelling |
| 38:27 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 38:111 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 125:157 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 129:24 | warning | 'macCatalyst' is a possible misspelling. | PostHogBase.Spelling |
| 131:111 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 133:64 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 143:40 | warning | 'tappable' is a possible misspelling. | PostHogBase.Spelling |
| 145:265 | warning | 'tappable' is a possible misspelling. | PostHogBase.Spelling |
| 157:63 | warning | 'tappable' is a possible misspelling. | PostHogBase.Spelling |
| 163:42 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
contents/docs/libraries/ios/_snippets/autocapture.mdx — 0 errors, 10 warnings, 4 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 6:19 | warning | 'Backgrounded' is a possible misspelling. | PostHogBase.Spelling |
| 6:78 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 9:24 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 10:29 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 11:8 | warning | 'rageclick' is a possible misspelling. | PostHogBase.Spelling |
| 11:27 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 13:65 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 13:108 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 52:80 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 56:150 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 56:156 | warning | 'UIButton' is a possible misspelling. | PostHogBase.Spelling |
| 56:179 | warning | 'UILabel' is a possible misspelling. | PostHogBase.Spelling |
| 60:28 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 62:31 | warning | 'UIView' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/product-analytics/_snippets/how-to-capture-anonymous-events-ios.mdx — 3 errors, 0 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 3:65 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 5:29 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 7:28 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
contents/docs/product-analytics/_snippets/how-to-capture-identified-events-ios.mdx — 0 errors, 0 warnings, 1 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 7:93 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
contents/docs/product-analytics/autocapture.mdx — 0 errors, 37 warnings, 3 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 16:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 18:54 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 29:118 | warning | 'pageleaves' is a possible misspelling. | PostHogBase.Spelling |
| 33:136 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 34:148 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 35:115 | warning | Use 'Contentful' instead of 'contentful'. | Vale.Terms |
| 35:187 | warning | Use 'Contentful' instead of 'contentful'. | Vale.Terms |
| 47:166 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 51:61 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 51:117 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 75:1 | warning | 'Autocaptures' is a possible misspelling. | PostHogBase.Spelling |
| 85:147 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 85:289 | warning | 'ignorelist' is a possible misspelling. | PostHogBase.Spelling |
| 86:151 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 87:117 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 88:119 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 89:120 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 90:120 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 91:125 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
| 141:110 | warning | 'pageleaves' is a possible misspelling. | PostHogBase.Spelling |
| 166:242 | warning | 'regionality' is a possible misspelling. | PostHogBase.Spelling |
| 227:135 | warning | 'rageclick' is a possible misspelling. | PostHogBase.Spelling |
| 238:256 | warning | 'textareas' is a possible misspelling. | PostHogBase.Spelling |
| 249:56 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 258:106 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 291:126 | warning | 'pageleaves' is a possible misspelling. | PostHogBase.Spelling |
| 291:190 | warning | 'pageleaves' is a possible misspelling. | PostHogBase.Spelling |
| 322:71 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 322:143 | warning | 'backgrounded' is a possible misspelling. | PostHogBase.Spelling |
| 369:70 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 369:142 | warning | 'backgrounded' is a possible misspelling. | PostHogBase.Spelling |
| 394:193 | warning | 'useSelector' is a possible misspelling. | PostHogBase.Spelling |
| 423:78 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 442:235 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 446:141 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 532:19 | warning | Use 'ID' instead of 'Id'. | Vale.Terms |
| 592:22 | warning | 'Debounce' is a possible misspelling. | PostHogBase.Spelling |
| 594:5 | warning | 'UISlider' is a possible misspelling. | PostHogBase.Spelling |
| 595:5 | warning | 'UISwitch' is a possible misspelling. | PostHogBase.Spelling |
| 607:48 | warning | Don't put a comma after 'e.g.,'. Write 'i.e.' or 'e.g.' with no comma after it. | PostHogBase.LatinAbbreviationComma |
contents/docs/product-analytics/installation/ios.mdx — 0 errors, 2 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 3:15 | warning | Use 'iOS' instead of 'ios'. | Vale.Terms |
| 23:28 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
contents/tutorials/ios-ab-tests.md — 0 errors, 8 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 17:45 | warning | Use 'Xcode' instead of 'XCode'. | Vale.Terms |
| 84:13 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 84:272 | warning | Use 'iOS' instead of 'ios'. | Vale.Terms |
| 90:66 | warning | 'initializer' is a possible misspelling. | PostHogBase.Spelling |
| 131:15 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 137:54 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 209:22 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 211:18 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/ios-analytics.md — 0 errors, 6 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 |
| 155:15 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 234:23 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 269:18 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 291:18 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 292:22 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/ios-feature-flags.md — 0 errors, 6 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 |
| 24:45 | warning | Use 'Xcode' instead of 'XCode'. | Vale.Terms |
| 117:15 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 128:44 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 182:22 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
contents/tutorials/ios-session-replay.md — 0 errors, 9 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 2:26 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 10:2 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 12:79 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 14:38 | warning | 'UIKit' is a possible misspelling. | PostHogBase.Spelling |
| 176:11 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. | PostHogBase.ProductNames |
| 204:15 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 204:170 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 213:4 | warning | '3. (Optional) Mask sensitive data' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 247:18 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
Contributor
Deploy preview
Changed pages
|
4 of 5 tasks
Contributor
Bundle reportTotal JS (gzip)12.21 MiB (-0.3 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.4 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.6 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.9 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).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Nov 20, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR moves the iOS docs to the iOS Markdown reference page. It was split out of #22334, which now holds React Native only. Merge it after posthog-ios 4.0.0 publishes its references.
/docs/libraries/ios/reference. Old redirects to the iOS pages now go to the reference page.Merge condition
Before 1 and 2, the build skips the iOS pages.
Screenshots of the nav come before this PR leaves draft.
Checklist
vercel.json🤖 Generated with Claude Code