Add OpenFeature (JavaScript) feature flags provider docs#18105
Add OpenFeature (JavaScript) feature flags provider docs#18105gustavohstrassburger wants to merge 2 commits into
Conversation
Documents the two official PostHog OpenFeature providers for JavaScript (@posthog/openfeature-node and @posthog/openfeature-web): installation, usage, evaluation-context mapping, supported flag types, and options. Companion to the posthog-js implementation PR (PostHog/posthog-js#3994), mirroring the existing OpenFeature (Python) page. Generated-By: PostHog Code Task-Id: 46a3f8c9-fbcd-460e-9457-fca583955e5a
Move installation and usage instructions out of the package READMEs and into the PostHog docs (companion PR PostHog/posthog.com#18105), so the guidance lives in one place and doesn't drift. Same approach as the Python provider. Each README keeps a short description and a link to the docs page. Generated-By: PostHog Code Task-Id: 46a3f8c9-fbcd-460e-9457-fca583955e5a
Deploy preview
|
|
Vale prose linter → found 5 errors, 1 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!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 11:120 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 42:38 | 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 |
| 48:23 | 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 |
| 49:27 | 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 |
| 61:69 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 76:8 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 82:27 | 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 |
| 83:21 | 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:45 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
Bundle reportTotal JS (gzip)6.33 MiB (+0.0 KiB / +0.0%) 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 |
713.8 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules |
573.8 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 |
./src/components/ProductComparisonTable/index.tsx + 116 modules |
267.6 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 |
./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.
Match the renamed packages: @posthog/openfeature-node-provider and @posthog/openfeature-web-provider (install commands and import snippets). Generated-By: PostHog Code Task-Id: 46a3f8c9-fbcd-460e-9457-fca583955e5a
There was a problem hiding this comment.
Pull request overview
Adds a new documentation page for PostHog’s official OpenFeature providers for JavaScript (Node + web), and links it from the feature flags installation navigation alongside the existing OpenFeature (Python) page.
Changes:
- Adds
/docs/feature-flags/installation/openfeature-jscovering install, usage, options, evaluation context mapping, and supported flag types for both JS providers. - Updates the docs navigation to include “OpenFeature (JavaScript)” next to “OpenFeature (Python)”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/navs/index.js | Adds the new OpenFeature (JavaScript) docs page to the Feature Flags installation menu. |
| contents/docs/feature-flags/installation/openfeature-js.mdx | New docs page describing setup and usage for the Node and web OpenFeature providers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // personalApiKey enables local evaluation | ||
| const posthog = new PostHog('<ph_project_api_key>', { host: '<ph_client_api_host>' }) | ||
|
|
What
Adds docs for the two official PostHog OpenFeature providers for JavaScript, mirroring the existing OpenFeature (Python) page:
@posthog/openfeature-node-provider— server/Node.js, backed byposthog-node+@openfeature/server-sdk@posthog/openfeature-web-provider— browser, backed byposthog-js+@openfeature/web-sdkNew page at
/docs/feature-flags/installation/openfeature-jscovering installation, usage, evaluation-context mapping, supported flag types, and options for both providers, plus a nav entry next to the Python one.Companion PR
Implementation: PostHog/posthog-js#3994 (the two provider packages). Usage instructions live here in the docs rather than the package READMEs so they stay in one place and don't drift — same approach as the Python provider.
🤖 Generated with Claude Code