Skip to content

docs(mcp-analytics): offer both SDKs in the quickstart - #20298

Merged
lucasheriques merged 2 commits into
masterfrom
lucas/mcp-quickstart-language-tabs
Sep 18, 2026
Merged

lucasheriques merged 2 commits into
masterfrom
lucas/mcp-quickstart-language-tabs

Conversation

@lucasheriques

@lucasheriques lucasheriques commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The MCP quickstart shows the full setup only for TypeScript. Python users must leave the page to find it. This PR adds equivalent installation and instrumentation tabs for both SDKs, using the existing components.

Required privacy guidance now comes before optional customization. The wizard remains available in an expandable section. The old setup anchor still works. The docs style guide gains a short component selection table and Markdown export checks.

Only two content files change. No components, dependencies, routes, or navigation entries change.

Merge after #20297, which adds the pnpm test:markdown command referenced by the authoring guide.

Validation

  • CI passes, including the Gatsby preview build.
  • Markdown lint and standalone MDX compilation pass for both pages.
  • All six TypeScript snippets and the Python snippet parse.
  • MCP links and anchors resolve. All eight quest sections remain.
  • Browser checks pass at 640px and 1440px in light and dark mode. Both installation and instrumentation tabs select TypeScript and Python. The wizard opens and closes. The old setup anchor resolves. Required sections precede optional work.
  • Converting the preview HTML with fix(docs): preserve content in Markdown exports #20297 preserves all ten code examples, both SDKs, and the closed wizard instructions. The authoring guide's component table and export checks also survive conversion.
  • git diff --check passes. CodeScene reports no applicable code changes.

Console comparison: Production and preview both report React hydration errors (#418/#423) and an SVG width warning. No new JavaScript error category appeared. The preview also returns 404 for the two .md URLs, as expected because minimal builds skip Markdown generation. These shared rendering issues remain outside this content change.

Local Gatsby startup still fails in FSEvents. Browser validation used the deployed CI preview instead. A full production Markdown publishing run was not performed.

Before and after screenshots

Before: current production. After: CI preview, with Python selected. Both languages were tested.

MCP quickstart

State Before After
Light, narrow before-quickstart-light-640 after-quickstart-light-640
Light, wide before-quickstart-light-1440 after-quickstart-light-1440
Dark, narrow before-quickstart-dark-640 after-quickstart-dark-640
Dark, wide before-quickstart-dark-1440 after-quickstart-dark-1440

Docs authoring guide

State Before After
Light, narrow before-guide-light-640 after-guide-light-640
Light, wide before-guide-light-1440 after-guide-light-1440
Dark, narrow before-guide-dark-640 after-guide-dark-640
Dark, wide before-guide-dark-1440 after-guide-dark-1440

Use existing language tabs for installation and instrumentation. Keep required privacy guidance before optional customization and preserve the old section anchor. Add component selection and Markdown export guidance to the docs style guide.

Validation: Markdown lint; standalone MDX compilation for both pages; six TypeScript snippets and one Python snippet parse; MCP links and anchors checked; git diff --check. Local Gatsby startup remains blocked, so browser validation uses the CI preview.
@github-actions

github-actions Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Sep 18, 2026 02:51PM

Changed pages

Page Source
Getting started with MCP Analytics contents/docs/mcp-analytics/start-here.mdx
Style guide for writing docs contents/handbook/wizard-and-docs/docs-style-guide.mdx

@github-actions github-actions Bot added docs Improvements or additions to product documentation, "Docs" content PR only touches files under contents/ labels Sep 18, 2026
The live QuestLog prefixes its heading IDs with quest-item-. Match that prefix on the alias for the renamed setup section. Verified against the live DOM.
@github-actions

github-actions Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 16 errors, 27 warnings, 3 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/mcp-analytics/start-here.mdx — 0 errors, 0 warnings, 1 suggestions
Line Severity Message Rule
179:15 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
contents/handbook/wizard-and-docs/docs-style-guide.mdx — 16 errors, 27 warnings, 2 suggestions
Line Severity Message Rule
14:98 warning Use American English. Use 'judgment' instead of 'judgement'. PostHogBase.AmericanEnglish
80:50 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
80:97 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
98:88 warning Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. PostHogBase.ProductNames
102:19 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
104:155 warning Capitalize 'Product Analytics' for PostHog's product. Use 'product analytics' for the general industry concept. PostHogBase.ProductNames
112:5 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
112:82 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
144:14 warning Use American English. Use 'color' instead of 'colour'. PostHogBase.AmericanEnglish
144:22 warning Use American English. Use 'analyze' instead of 'analyse'. PostHogBase.AmericanEnglish
144:41 warning Use American English. Use 'license' instead of 'licence'. PostHogBase.AmericanEnglish
160:38 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
160:58 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
162:41 warning Capitalize 'Session Replay' for PostHog's product. Use 'session replay' for the general industry concept. PostHogBase.ProductNames
162:60 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
176:36 warning Use the Oxford comma before 'and' or 'or' in a list of three or more items. PostHogBase.OxfordComma
180:174 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
186:76 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
194:31 warning 'initialisms' is a possible misspelling. PostHogBase.Spelling
198:14 warning Use 'SQL' instead of 'Sql'. Vale.Terms
198:19 warning Use 'API' instead of 'Api'. Vale.Terms
198:24 warning Use 'HTML' instead of 'Html'. Vale.Terms
233:3 suggestion Prefer 'denylist' over 'blacklist'. PostHogBase.Inclusivity
233:13 suggestion Prefer 'allowlist' over 'whitelist'. PostHogBase.Inclusivity
281:3 warning Capitalize 'Feature Flags' for PostHog's product. Use 'Feature flags' for the general industry concept. PostHogBase.ProductNames
299: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
300: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
301: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
301:58 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
307:57 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
327:7 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
337:29 warning Capitalize 'Data Pipelines' for PostHog's product. Use 'data pipelines' for the general industry concept. PostHogBase.ProductNames
365: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
366: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
367: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
369:26 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
459:21 warning Use descriptive link text instead of '[this link]'. PostHogBase.DescriptiveLinkText
467: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
468: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
474: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
475: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
476: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
537: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
537:66 warning 'devtools' is a possible misspelling. PostHogBase.Spelling
544:14 warning Capitalize 'Workflows' for PostHog's product. Use 'workflows' for the general industry concept. PostHogBase.ProductNames

@github-actions

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

8.66 MiB (no change)

Eager graph (modules shipped in each entrypoint's initial chunks)

Entrypoint Eager size Budget Modules
✅ app 18.58 MiB (no change) report-only 2067
Largest modules in the app closure
Module Size
./src/data/mcp-tools.json 1163.3 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 773.1 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 372.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
./src/components/ProductComparisonTable/index.tsx + 126 modules 305.8 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).

@lucasheriques
lucasheriques marked this pull request as ready for review September 18, 2026 14:55
@lucasheriques
lucasheriques merged commit 02122e4 into master Sep 18, 2026
21 of 22 checks passed
@lucasheriques
lucasheriques deleted the lucas/mcp-quickstart-language-tabs branch September 18, 2026 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content PR only touches files under contents/ docs Improvements or additions to product documentation, "Docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant