docs: improve experimentation documentation and messaging#1388
Open
vanshiz wants to merge 4 commits into
Open
Conversation
✅ Deploy Preview for openfeature ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation and landing page updates for OpenFeature's experimentation capabilities. It adds a new dedicated 'Experimentation' concept page detailing the roles of the Tracking API, Hooks, and Targeting Key, along with multi-language code examples and a sequence diagram. Additionally, it updates the tracking documentation with an experimentation-focused example, includes an experimentation summary in the introduction, and adds a 'Built for experimentation' feature section to the landing page. I have no feedback to provide.
Signed-off-by: vanshiz <vanshikabhargava29@gmail.com>
Signed-off-by: vanshiz <vanshikabhargava29@gmail.com>
Signed-off-by: vanshiz <vanshikabhargava29@gmail.com>
Signed-off-by: vanshiz <vanshikabhargava29@gmail.com>
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.
This PR
Addresses the experimentation documentation and messaging improvements
raised in #1362.
08-experimentation.mdx)explaining how the tracking API, hooks, and targeting key work together
for A/B testing and experimentation workflows
(
07-tracking.mdx) showing a complete flag evaluation + conversiontracking flow in TypeScript, Java, C# and Go
intro.mdx)linking to the new concepts page
use case
Related Issues
Closes #1362
Notes
A blog post/tutorial (also suggested in the issue) is left as a
follow-up , happy to take that on in a separate PR once this is reviewed.
Follow-up Tasks
How to test
yarn && yarn submodules yarn start/docs/reference/introand verify the Experimentation sectionappears between Hooks and Events
/docs/reference/concepts/experimentationand verify the newpage renders correctly including the Mermaid diagram and code tabs
/docs/reference/concepts/trackingand verify the newExperimentation-Focused Example section appears at the bottom
appears as the 4th item in the features grid
Screenshots
New experimentation concepts page
Intro page — Experimentation section
Homepage — Built for experimentation
Tracking page — Experimentation-focused example
