Docs: align self-driving positioning (apps → tools)#17867
Draft
charlescook-ph wants to merge 1 commit into
Draft
Docs: align self-driving positioning (apps → tools)#17867charlescook-ph wants to merge 1 commit into
charlescook-ph wants to merge 1 commit into
Conversation
Reflect the confirmed products <> tools <> context taxonomy in the docs: - Rename the "Your apps" section in the web app docs to "Your tools" and stop calling each capability an "app". - Broaden the context docs to include other business data (Slack, code, Notion, support tickets). - Add glossary entries for Tool, Context, Context warehouse, and Self-driving. Generated-By: PostHog Code Task-Id: d6b44c7d-c10c-43e6-a486-d72d14dc24ee
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 13 errors, 77 warnings, 1 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 |
|---|---|---|---|
| 7:159 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 14:192 | 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 |
| 23:279 | warning | 'activiity' is a possible misspelling. | PostHogBase.Spelling |
| 31:6 | warning | 'ARR' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 32:24 | 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 |
| 38:96 | warning | 'userbase' is a possible misspelling. | PostHogBase.Spelling |
| 42:6 | warning | 'B2B' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 45:6 | warning | 'B2C' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 46:151 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 48:6 | warning | 'BAA' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 52:29 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 52:64 | warning | 'autocaptures' is a possible misspelling. | PostHogBase.Spelling |
| 56:6 | warning | 'CAC' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 75:427 | 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 |
| 81:128 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 84:46 | warning | Capitalize 'Data Warehouse' for PostHog's product. Use 'data warehouse' for the general industry concept. | PostHogBase.ProductNames |
| 84:126 | warning | Capitalize 'Data Pipelines' for PostHog's product. Use 'data pipelines' for the general industry concept. | PostHogBase.ProductNames |
| 89:6 | warning | 'CPA' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 95:6 | warning | 'CTR' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 104:169 | warning | Avoid trivializing words. 'easily' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 106:6 | warning | 'Data warehouse' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 106:6 | warning | Capitalize 'Data Warehouse' for PostHog's product. Use 'Data warehouse' for the general industry concept. | PostHogBase.ProductNames |
| 107:3 | warning | Capitalize 'Data Warehouse' for PostHog's product. Use 'data warehouse' for the general industry concept. | PostHogBase.ProductNames |
| 107:86 | warning | Capitalize 'Data Warehouse' for PostHog's product. Use 'data warehouse' for the general industry concept. | PostHogBase.ProductNames |
| 109:6 | warning | 'DAU' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 126:1 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 126:54 | 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:275 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 129:89 | 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 |
| 143:103 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 143:139 | 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 |
| 146:103 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 148:6 | warning | 'GTM' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 149:164 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 154:94 | warning | Use American English. Use 'colors' instead of 'colours'. | PostHogBase.AmericanEnglish |
| 177:62 | warning | Use 'GitHub' instead of 'Github'. | Vale.Terms |
| 185:6 | warning | 'K Factor' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 186:32 | warning | 'virality' is a possible misspelling. | PostHogBase.Spelling |
| 189:105 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 193:6 | warning | 'LTV' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 198:6 | warning | 'MAU' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 201:6 | warning | 'MOM' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 204:6 | warning | 'MQL' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 207:6 | warning | 'MRR' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 208:25 | 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 |
| 211:144 | warning | Capitalize 'Experimentation' for PostHog's product. Use 'experimentation' for the general industry concept. | PostHogBase.ProductNames |
| 213:6 | warning | 'MVP' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 214:167 | warning | 'MVPs' is a possible misspelling. | PostHogBase.Spelling |
| 224:6 | warning | 'NPS' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 225:262 | 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 |
| 225:291 | warning | Use American English. Use 'labeled' instead of 'labelled'. | PostHogBase.AmericanEnglish |
| 225:347 | warning | Use American English. Use 'labeled' instead of 'labelled'. | PostHogBase.AmericanEnglish |
| 225:388 | warning | Use American English. Use 'labeled' instead of 'labelled'. | PostHogBase.AmericanEnglish |
| 229:6 | warning | 'OKR' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 241:73 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 247:151 | 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 |
| 247:199 | 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 |
| 253:50 | warning | Use American English. Use 'favorite' instead of 'favourite'. | PostHogBase.AmericanEnglish |
| 258:6 | warning | 'PQL' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 261:6 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 261:6 | warning | 'Product analytics' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 262:118 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 262:307 | warning | 'idenfitied' is a possible misspelling. | PostHogBase.Spelling |
| 301:69 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
| 301:108 | warning | 'technographic' is a possible misspelling. | PostHogBase.Spelling |
| 304:227 | warning | 'reactively' is a possible misspelling. | PostHogBase.Spelling |
| 324:89 | 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 |
| 327:54 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 327:73 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 327:89 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 327:104 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 327:117 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 327:133 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 330:140 | warning | Avoid trivializing words. 'easily' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 330:270 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 337:6 | warning | 'UGC' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 340:6 | warning | 'UTM' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 345:74 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 347:6 | warning | 'VM' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 353:243 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 361:6 | warning | 'YOY' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
contents/docs/self-driving/context.mdx — 0 errors, 5 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 26:86 | warning | Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. | PostHogBase.ProductNames |
| 26:186 | warning | Capitalize 'Surveys' for PostHog's product. Use 'surveys' for the general industry concept. | PostHogBase.ProductNames |
| 28:5 | warning | 'Your data warehouse and imports' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 28:10 | warning | Capitalize 'Data Warehouse' for PostHog's product. Use 'data warehouse' for the general industry concept. | PostHogBase.ProductNames |
| 30:14 | warning | Capitalize 'Data Warehouse' for PostHog's product. Use 'data warehouse' for the general industry concept. | PostHogBase.ProductNames |
contents/docs/self-driving/web.mdx — 2 errors, 3 warnings, 0 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 23: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 |
| 23:22 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 23:41 | warning | Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. | PostHogBase.ProductNames |
| 23:57 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 23:85 | 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 |
Contributor
Bundle reportTotal JS (gzip)6.21 MiB (no change) Eager graph (static-import closure per entrypoint)
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 |
710.3 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules |
531.3 KiB |
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js |
481.4 KiB |
./node_modules/.pnpm/@codemirror+view@6.38.2/node_modules/@codemirror/view/dist/index.js |
458.1 KiB |
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules |
395.1 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.cjs.js |
364.8 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 |
./src/hooks/useCustomers.tsx + 54 modules |
353.9 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/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
./node_modules/.pnpm/@codesandbox+sandpack-react@2.20.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@codesandbox/sandpack-react/dist/index.mjs |
266.6 KiB |
./src/components/ProductComparisonTable/index.tsx + 114 modules |
264.0 KiB |
./node_modules/.pnpm/d3@7.9.0/node_modules/d3/src/index.js + 208 modules |
247.4 KiB |
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules |
239.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.
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
1 participant
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
Aligns the docs with the confirmed products <> tools <> context taxonomy. Minimal, high-signal copy pass — no sweep of incidental "app" mentions across product docs.
Why: Following the positioning meeting confirming the products/tools/context taxonomy, so the docs use the same words as marketing and the product pages. Pairs with the handbook PR (#17866) and the product/app pages PR (#17670).
Checklist
vercel.jsonCreated with PostHog Code from a Slack thread