Skip to content

Add custom experiment reference docs#499

Merged
dkotter merged 2 commits into
WordPress:developfrom
yusufhay:docs/184-custom-experiment-reference-fork
May 4, 2026
Merged

Add custom experiment reference docs#499
dkotter merged 2 commits into
WordPress:developfrom
yusufhay:docs/184-custom-experiment-reference-fork

Conversation

@yusufhay
Copy link
Copy Markdown
Contributor

@yusufhay yusufhay commented May 3, 2026

What?

Closes #184

Adds a documented custom experiment reference for developers extending the AI plugin.

Why?

The repository already includes example experiment code, but it is not surfaced as an easy-to-follow reference for plugin developers. This makes the extension path harder to discover than it needs to be.

How?

  • add a new docs/experiments/custom-experiment-reference.md page
  • link that reference from the developer guide table of contents and resources section
  • add a short pointer from the main README developer experience section
  • clearly mark the example as reference/demo code and point readers to the in-repo Example_Experiment implementation

Use of AI Tools

AI assistance: Yes
Tool(s): Codex
Model(s): GPT-5
Used for: drafting the initial documentation update and PR text; final file changes were reviewed and committed by me.

Testing Instructions

  1. Open docs/experiments/custom-experiment-reference.md and confirm the example explains how to register a custom experiment.
  2. Open docs/DEVELOPER_GUIDE.md and confirm the new reference is linked from the table of contents, experiment creation section, and resources section.
  3. Open README.md and confirm the developer experience section links to the new reference page.

Screenshots or screencast

Not applicable.

Changelog Entry

Development Update - Add custom experiment reference documentation for developers extending the plugin.

Open WordPress Playground Preview

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 3, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: yusufhay <yusufmudagal@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>
Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.16%. Comparing base (afc7cb4) to head (32ca142).
⚠️ Report is 437 commits behind head on develop.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop     #499      +/-   ##
=============================================
+ Coverage      62.64%   69.16%   +6.52%     
- Complexity       681      981     +300     
=============================================
  Files             49       63      +14     
  Lines           3515     4648    +1133     
=============================================
+ Hits            2202     3215    +1013     
- Misses          1313     1433     +120     
Flag Coverage Δ
unit 69.16% <ø> (+6.52%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@yusufhay yusufhay force-pushed the docs/184-custom-experiment-reference-fork branch from 143a88c to f7cdfb1 Compare May 3, 2026 18:38
@jeffpaul jeffpaul added this to the 0.9.0 milestone May 4, 2026
@jeffpaul jeffpaul requested review from dkotter and jeffpaul May 4, 2026 20:20
jeffpaul
jeffpaul previously approved these changes May 4, 2026
Comment thread docs/experiments/custom-experiment-reference.md Outdated
Co-authored-by: Darin Kotter <darin.kotter@gmail.com>
@dkotter dkotter merged commit 7b74298 into WordPress:develop May 4, 2026
16 checks passed
simison pushed a commit to simison/ai that referenced this pull request May 25, 2026
Co-authored-by: yusufhay <yusufmudagal@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>
Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add developer reference examples for extending AI Experiments

3 participants