Skip to content

chore(): add Workflows and SDK documentation around push notifications#16177

Draft
havenbarnes wants to merge 1 commit intomasterfrom
feat/push-notifs-documentation
Draft

chore(): add Workflows and SDK documentation around push notifications#16177
havenbarnes wants to merge 1 commit intomasterfrom
feat/push-notifs-documentation

Conversation

@havenbarnes
Copy link
Copy Markdown
Contributor

Changes

Please describe.

Add screenshots or screen recordings for visual / UI-focused changes.

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Apr 03, 2026 09:31PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Vale prose linter → found 8 errors, 70 warnings, 11 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/libraries/ios/configuration.mdx — 1 errors, 26 warnings, 1 suggestions
Line Severity Message Rule
6:18 warning Use 'GitHub' instead of 'github'. Vale.Terms
6:37 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
6:45 warning Use 'iOS' instead of 'ios'. Vale.Terms
7:15 warning Use 'iOS' instead of 'ios'. Vale.Terms
48:97 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
136:5 warning 'Chaining multiple BeforeSendBlocks' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
161:25 warning 'beforeSend' is a possible misspelling. PostHogBase.Spelling
176:180 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
176:196 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
184:3 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
185:45 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
187:136 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
200:234 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
220:101 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
224:104 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
225:89 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
226:226 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
226:242 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
227:87 warning 'UIKit' is a possible misspelling. PostHogBase.Spelling
227:111 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
227:172 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
229:78 warning 'Preload' is a possible misspelling. PostHogBase.Spelling
229:86 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
230:136 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
231:92 warning 'Logcat' is a possible misspelling. PostHogBase.Spelling
233:163 warning Use 'ID' instead of 'id'. Vale.Terms
234:146 warning 'wifi' is a possible misspelling. PostHogBase.Spelling
239:119 warning Use 'ID' instead of 'Id'. Vale.Terms
contents/docs/libraries/ios/usage.mdx — 0 errors, 25 warnings, 10 suggestions
Line Severity Message Rule
6:18 warning Use 'GitHub' instead of 'github'. Vale.Terms
6:37 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
6:45 warning Use 'iOS' instead of 'ios'. Vale.Terms
29:53 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
39:46 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
87:153 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
87:191 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
93:106 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
111:49 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
113:66 suggestion Address the reader directly. Use 'you' instead of 'the User'. PostHogDocs.DirectAddress
113:131 suggestion Address the reader directly. Use 'you' instead of 'the User'. PostHogDocs.DirectAddress
125:70 warning Avoid trivializing words. 'simply' can sound dismissive to the reader. PostHogDocs.Trivializers
129:10 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
129:94 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
129:103 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
187:4 warning 'Feature flags' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
187:4 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
199:8 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
199:51 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
199:124 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
207:28 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
207:54 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
211:185 warning Use 'iOS' instead of 'ios'. Vale.Terms
213:23 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
213:31 warning Use 'iOS' instead of 'ios'. Vale.Terms
221:52 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
250:54 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
264:4 warning 'Session replay' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
264:4 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
266:13 warning Capitalize 'Session Replay' for PostHog's product. Use 'Session replay' for the general industry concept. PostHogBase.ProductNames
268:12 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
268:74 warning Avoid trivializing words. 'all you need to do' can sound dismissive to the reader. PostHogDocs.Trivializers
276:62 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
276:100 warning Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. PostHogBase.ProductNames
286:26 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
contents/docs/workflows/configure-channels.mdx — 1 errors, 5 warnings, 0 suggestions
Line Severity Message Rule
2:21 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
15:59 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
17:32 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
40:22 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
131:84 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
139:20 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/workflows/library.mdx — 1 errors, 4 warnings, 0 suggestions
Line Severity Message Rule
7:65 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
7:122 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
19:14 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
75:52 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
95:161 warning Avoid trivializing words. 'easily' can sound dismissive to the reader. PostHogDocs.Trivializers
contents/docs/workflows/start-here.mdx — 0 errors, 2 warnings, 0 suggestions
Line Severity Message Rule
2:29 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
50:141 warning Use 'A/B' instead of 'a/b'. Vale.Terms
contents/docs/workflows/workflow-builder.mdx — 5 errors, 8 warnings, 0 suggestions
Line Severity Message Rule
25:22 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
34:173 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
38:7 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
99:91 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
103:78 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
104:117 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
117:105 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
119:1 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
120:1 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
121:1 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
122:1 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
126:48 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames
130:71 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

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