close
Skip to content

Add missing experiment documentation pages and cross-links#475

Merged
jeffpaul merged 6 commits into
WordPress:developfrom
dilipom13:docs/221-missing-experiment-pages
May 18, 2026
Merged

Add missing experiment documentation pages and cross-links#475
jeffpaul merged 6 commits into
WordPress:developfrom
dilipom13:docs/221-missing-experiment-pages

Conversation

@dilipom13
Copy link
Copy Markdown
Contributor

@dilipom13 dilipom13 commented Apr 25, 2026

What?

Closes #221

Add missing experiment documentation pages for:

  • Title Generation
  • Experiment Framework
  • Multi-Provider Support

Also, cross-link these new docs from relevant documentation entry points.

Why?

Several experiment-related capabilities existed in code and user-facing docs lists, but dedicated pages under docs/experiments/ were missing.
This made documentation inconsistent and reduced discoverability for contributors and users trying to understand these features and extension points.

How?

  • Added new documentation files:
    • docs/experiments/title-generation.md
    • docs/experiments/experiment-framework.md
    • docs/experiments/multi-provider-support.md
  • Linked the new docs from:
    • README.md (Current Features section)
    • readme.txt (Current Features section)
    • docs/DEVELOPER_GUIDE.md (Additional Resources)

Use of AI Tools

AI assistance: No

Testing Instructions

  1. Verify the following files exist and render correctly:
    • docs/experiments/title-generation.md
    • docs/experiments/experiment-framework.md
    • docs/experiments/multi-provider-support.md
  2. Open README.md and confirm links to the 3 new docs are present in Current Features.
  3. Open readme.txt and confirm links to the 3 new docs are present in Current Features.
  4. Open docs/DEVELOPER_GUIDE.md and confirm the 3 new docs are listed in Additional Resources.
  5. Click each added link to confirm it resolves correctly.

Screenshots or screencast

Not applicable (documentation-only changes).

Changelog Entry

Development Update - Add missing experiment documentation pages and cross-link them from project docs/readmes.

Open WordPress Playground Preview

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 25, 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: dilipom13 <dilip2615@git.wordpress.org>
Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: dhrumilkumbhani <dhrumilk@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 Apr 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.21%. Comparing base (b9f820d) to head (df79750).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #475   +/-   ##
==========================================
  Coverage      71.21%   71.21%           
  Complexity      1151     1151           
==========================================
  Files             67       67           
  Lines           5565     5565           
==========================================
  Hits            3963     3963           
  Misses          1602     1602           
Flag Coverage Δ
unit 71.21% <ø> (ø)

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.

Comment thread docs/experiments/title-generation.md Outdated

### Editor UX Flow

1. The experiment enqueues `src/experiments/title-generation/index.tsx` on post edit screens.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. The experiment enqueues src/experiments/title-generation/index.tsx on post editing screens.

This is my suggestion—if it looks good, we can update it like this.

- Google `gemini-3-flash-preview`, `gemini-2.5-flash`
- OpenAI `gpt-5.4-mini`, `gpt-4.1-mini`

When earlier preferences are unavailable, lower-priority entries act as fallback candidates.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When higher-priority preferences are unavailable.

This is my suggestion—if it looks good, we can update it like this.

@jeffpaul jeffpaul added this to the 0.9.0 milestone May 7, 2026
@jeffpaul jeffpaul mentioned this pull request May 7, 2026
31 tasks
@dkotter dkotter modified the milestones: 0.9.0, 1.0.0 May 7, 2026
@dilipom13
Copy link
Copy Markdown
Contributor Author

@dkotter, conflict issue resolved, and updated the branch.

@jeffpaul
Copy link
Copy Markdown
Member

Removing title gen updates and accepting what's in develop from #501.

@jeffpaul jeffpaul merged commit d8c6c92 into WordPress:develop May 18, 2026
16 checks passed
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 missing experiment documentation pages

4 participants