fix(docs): name the SDK on the aged-out reference notice - #20163
Draft
posthog[bot] wants to merge 1 commit into
Draft
posthog[bot] wants to merge 1 commit into
posthog[bot] wants to merge 1 commit into
Conversation
The notice page read the requested SDK and version from window.location.pathname. Gatsby replaces that path with the page's own path on hydration, so the parse always failed and every reader got the generic copy. Read the requested URL from the navigation timing entry instead, which keeps the URL the document was requested with. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Generated-By: PostHog Desktop Task-Id: 9e9acf6c-191b-48ac-a5c8-4a5ece1807fc
Contributor
Author
Contributor
Deploy preview
|
Contributor
Bundle reportTotal JS (gzip)8.78 MiB (+0.1 KiB / +0.0%) Eager graph (modules shipped in each entrypoint's initial chunks)
Largest modules in the
|
| Module | Size |
|---|---|
./src/data/mcp-tools.json |
1137.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 |
773.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).
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
Readers who ask for an SDK reference version that aged out of the build get a notice page. That page was written to name the SDK and version they asked for, and to link to the current reference for that SDK. It never did either: everybody got the generic copy, whose only link is "Browse all SDK docs".
Problem
version-unavailable.tsxread the SDK and version fromwindow.location.pathnameafter mount.vercel.jsonrewrite is transparent, but Gatsby is not: when the served page'swindow.pagePathdiffers from the browser path, Gatsby's runtime replaces the address bar with the page path and keeps only the query string (production-app.js). Behind this rewrite that is always true, so the parse always failed.Fix
performance.getEntriesByType('navigation')[0].name). It records the URL the document was fetched with, and the history replacement does not change it.?ref=override and the parser are unchanged.Two approaches that do not work
?ref=:slugVersion picker (
SdkReference.tsx): no change. It lists every sourced version on purpose, and Gatsby falls back to a full page load when a page fails to load, so a picker entry with no page reaches the rewrite and now gets the named notice.Screenshots
The "after" column is production, opened with the
?ref=override that already renders this branch. The environment cannot build the site, so the branch itself is not pictured; the override feeds the same JSX the fix feeds.How the root cause and the fix were verified
Headless Chromium, against production, on
/docs/references/posthog-react-native-4.61.0:location.pathnamereads/docs/references/version-unavailable, which confirms the parse can never succeed. The page renders the generic copy.performance.getEntriesByType('navigation')[0].namestill readshttps://posthog.com/docs/references/posthog-react-native-4.61.0.{ sdk: 'posthog-react-native', version: '4.61.0' }. It also resolves a types subpath (/docs/references/posthog-js-1.203.1/types/Survey) and the?ref=override.pnpm format(Prettier 2, repo config) andnode --test src/components/SdkReferences/utils.test.tsboth pass.Not tested: the dev server and the production build. This environment has no
node_modulesand cannot install them, so there is no local console check. The Vercel preview build covers both.Checklist
vercel.json— no page movedCreated with PostHog Desktop from this inbox report.
🤖 Generated with Claude Code