Rewrite and expand README documentation #54
+517
−144
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.
Description
New "When to Use This Plugin" section — comparison table explaining when to use field-level vs page-level experiments, helping users choose the right approach
New "Page-Level Experiments" section — step-by-step guide covering plugin configuration with a reference field, creating a route experiment document type, querying the correct page, and implementing a proxy for routing
New "Variant Assignment" section — documents cookie-based assignment, variant ID consistency, reading variants in page components, and third-party integration patterns
Improved examples throughout — replaced generic placeholder examples (e.g.,
experiment 1,123-a) with realistic, self-documenting ones (e.g.,Homepage Headline Test,control,Emotional Appeal)Expanded "Overwriting field names" — added a concrete audience segmentation example with stored data structure and query patterns
Improved "Split testing" section — renamed to "Split testing (URL-based)" with complete working code examples including cookie handling
Added visual aids — beaker icon SVG for inline rendering, screenshots showing the field-level and page-level experiment UIs (
field-experiment.png,page-experiment.png)Added links to the example repository and a Loom video walkthrough
Fixed typos and formatting — "know" to "known", "defined" to "define", "intto" to "into", fixed broken markdown anchor links, removed duplicate License entry from TOC
Added new files:
beaker.svg— icon used inline in the README to explain the experiment picker,field-experiment.png— screenshot of the field-level experiment UI,page-experiment.png— screenshot of the page-level experiment UIWhat to review
Testing