docs: add a troubleshooting path to the Shopify guide - #20101
Draft
posthog[bot] wants to merge 2 commits into
Draft
posthog[bot] wants to merge 2 commits into
posthog[bot] wants to merge 2 commits into
Conversation
The Shopify guide told readers to verify the install in the activity tab and stopped there. It linked to no troubleshooting page, so a reader with an empty activity tab had no next step. Add a short "If your events do not appear" section next to the verification step. It names the two causes the guide missed - a token that is for a different project, and a third-party Shopify app that controls what it sends - then links to the product analytics troubleshooting page for everything else. Also add the wrong-project token cause to the product analytics troubleshooting page, because it applies to every library, not just Shopify. Generated-By: PostHog Desktop Task-Id: 5f57a033-1996-4724-a563-7dd21af4d396
Contributor
Author
🦔 PostHog Review reviewed this pull requestFound 0 must fix, 1 should fix, 0 consider. Published 1 finding (view the review). Resolved comments: 1 fixed |
github-actions
Bot
added
docs
Contributor
Deploy preview
Changed pages
|
Contributor
|
Vale prose linter → found 3 errors, 43 warnings, 2 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:66 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 7:104 | warning | Use 'Shopify' instead of 'shopify'. | Vale.Terms |
| 9:66 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 9:104 | warning | Use 'Shopify' instead of 'shopify'. | Vale.Terms |
| 11:18 | warning | Avoid trivializing words. 'easy to' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 16:53 | warning | Use 'X' instead of 'x'. | Vale.Terms |
| 27:69 | 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:76 | warning | Capitalize 'Product Analytics' for PostHog's product. Use 'Product analytics' for the general industry concept. | PostHogBase.ProductNames |
| 87:132 | warning | Use bold (text) for UI elements, not quotes. | PostHogDocs.UIBoldNotQuotes |
| 97:224 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 191:194 | warning | 'webpages' is a possible misspelling. | PostHogBase.Spelling |
| 218:12 | warning | 'regionality' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/product-analytics/troubleshooting.mdx — 2 errors, 33 warnings, 1 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 15:57 | error | Use straight quotes and apostrophes, not curly ones. | PostHogDocs.CurlyQuotes |
| 15:73 | error | Use straight quotes and apostrophes, not curly ones. | PostHogDocs.CurlyQuotes |
| 16:103 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 16:133 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 99:138 | warning | 'devtools' is a possible misspelling. | PostHogBase.Spelling |
| 101:9 | warning | 'devtools' is a possible misspelling. | PostHogBase.Spelling |
| 106:33 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 120:123 | warning | 'devtools' is a possible misspelling. | PostHogBase.Spelling |
| 127:5 | warning | 'It's none of the above. How do I report an issue?' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 203:32 | warning | 'ahrefsbot' is a possible misspelling. | PostHogBase.Spelling |
| 204:4 | warning | Use 'APIs' instead of 'apis'. | Vale.Terms |
| 204:32 | warning | 'applebot' is a possible misspelling. | PostHogBase.Spelling |
| 205:32 | warning | 'baiduspider' is a possible misspelling. | PostHogBase.Spelling |
| 206:32 | warning | 'bingbot' is a possible misspelling. | PostHogBase.Spelling |
| 207:32 | warning | 'bingpreview' is a possible misspelling. | PostHogBase.Spelling |
| 209:36 | warning | Use 'PHP' instead of 'php'. | Vale.Terms |
| 210:4 | warning | 'googlebot' is a possible misspelling. | PostHogBase.Spelling |
| 211:4 | warning | 'googleweblight' is a possible misspelling. | PostHogBase.Spelling |
| 211:32 | warning | 'duckduckbot' is a possible misspelling. | PostHogBase.Spelling |
| 212:32 | warning | 'facebookexternal' is a possible misspelling. | PostHogBase.Spelling |
| 213:32 | warning | 'facebookcatalog' is a possible misspelling. | PostHogBase.Spelling |
| 214:32 | warning | 'gptbot' is a possible misspelling. | PostHogBase.Spelling |
| 215:32 | warning | Use 'HubSpot' instead of 'hubspot'. | Vale.Terms |
| 216:32 | warning | 'linkedinbot' is a possible misspelling. | PostHogBase.Spelling |
| 218:32 | warning | 'petalbot' is a possible misspelling. | PostHogBase.Spelling |
| 219:32 | warning | Use 'Pinterest' instead of 'pinterest'. | Vale.Terms |
| 220:32 | warning | 'prerender' is a possible misspelling. | PostHogBase.Spelling |
| 221:32 | warning | 'rogerbot' is a possible misspelling. | PostHogBase.Spelling |
| 223:32 | warning | 'semrushbot' is a possible misspelling. | PostHogBase.Spelling |
| 224:32 | warning | 'sitebulb' is a possible misspelling. | PostHogBase.Spelling |
| 225:32 | warning | 'twitterbot' is a possible misspelling. | PostHogBase.Spelling |
| 227:32 | warning | 'yandexbot' is a possible misspelling. | PostHogBase.Spelling |
| 229:84 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 233:120 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 255:147 | warning | Use 'ClickHouse' instead of 'Clickhouse'. | Vale.Terms |
| 257:1 | warning | Use the Oxford comma before 'and' or 'or' in a list of three or more items. | PostHogBase.OxfordComma |
Contributor
Author
|
PostHog Review alpha 🦔 If you find any issues helpful - please reply "valid", "invalid", etc., for evaluation purposes 🙏 |
![posthog[bot]](https://avatars.githubusercontent.com/in/1203049?s=60&v=4){kind=small}
The two project settings links this PR added pointed at us.posthog.com, which forces every reader into the US app. The docs style guide requires https://app.posthog.com/ for in-app links, because that host redirects each user to their own US or EU subdomain, and it gives the us.posthog.com form as an explicit "Don't". This matters more here than in a general link: both new lines ask the reader to compare the token in their code against the token on the linked page. An EU Cloud reader who also holds a US account would land on a US project, read a token that belongs to a different project, and "correct" their code to the wrong token - the exact failure this new cause exists to diagnose. Pre-existing us.posthog.com links elsewhere in these two files are left alone as out of scope. Generated-By: PostHog Desktop Task-Id: ec8c838d-e425-47ec-8bb6-365e6ede1869
Contributor
Bundle reportTotal JS (gzip)8.87 MiB (no change) Eager graph (modules shipped in each entrypoint's initial chunks)
Largest modules in the
|
| Module | Size |
|---|---|
./src/data/mcp-tools.json |
1125.8 KiB |
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 |
762.5 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 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/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/x-ray.mjs |
480.8 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+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/im-the-driver.mjs |
385.7 KiB |
./src/hooks/useCustomers.tsx + 55 modules |
370.0 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 |
./src/components/ProductComparisonTable/index.tsx + 126 modules |
305.7 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/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/doll-house.mjs |
281.7 KiB |
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/director.mjs |
275.6 KiB |
./src/components/SearchUI/index.tsx + 87 modules |
273.7 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).
5 tasks
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
Problem
contents/docs/libraries/shopify.mdxlinks to no troubleshooting page at all.contents/docs/product-analytics/troubleshooting.mdxmisses the cause that fits this case: a token that is for a different project. The request returns 200, so the reader sees success and no events.Changes
theme.liquidagainst the token in project settingsVerification
prettier --checkpasses on both files.pnpm start, then both pages loaded on the dev server. Each page-data build carries the new text and no MDX error.#why-are-events-not-appearing-in-my-projectis confirmed against the generated heading id, not assumed.Agent context
Checklist
vercel.json— no page movedCreated with PostHog Desktop from this inbox report.