Skip to content

refactor: rename Review Notes → Editorial Notes, Refine from Notes → Editorial Updates#528

Open
zeus2611 wants to merge 12 commits into
WordPress:developfrom
zeus2611:feature/issue-506-rename-editorial-notes
Open

refactor: rename Review Notes → Editorial Notes, Refine from Notes → Editorial Updates#528
zeus2611 wants to merge 12 commits into
WordPress:developfrom
zeus2611:feature/issue-506-rename-editorial-notes

Conversation

@zeus2611
Copy link
Copy Markdown
Contributor

@zeus2611 zeus2611 commented May 9, 2026

Closes #506

Renames the "Review Notes" and "Refine from Notes" experiments to "Editorial Notes" and "Editorial Updates" respectively, across all PHP, TypeScript, docs, tests, and build configuration.

Why?

The original experiment names were internal/developer-facing labels that didn't clearly communicate their purpose to editors. "Editorial Notes" and "Editorial Updates" better describe the user-facing value of each feature.

How?

PHP

  • Renamed Experiments\Review_NotesExperiments\Editorial_Notes and Experiments\Refine_NotesExperiments\Editorial_Updates
  • Renamed Abilities\Review_NotesAbilities\Editorial_Notes and Abilities\Refine_NotesAbilities\Editorial_Updates
  • Ability slugs changed: ai/review-notesai/editorial-notes, ai/refine-notesai/editorial-updates
  • Added V1_0_0 upgrade migration to carry over any previously-enabled feature options from the old option keys to the new ones

TypeScript / JS

  • Renamed src/experiments/review-notes/editorial-notes/ and refine-notes/editorial-updates/
  • Updated all slug references, localized data globals, and UI strings
  • Updated webpack.config.js entry points

Tests

  • Renamed and updated integration tests for both abilities and experiments
  • Renamed and updated E2E specs; updated fixture routing in e2e-request-mocking.php to match renamed fixture files
  • Renamed E2E fixture files (review-notes-*editorial-notes-*, refine-notes-*editorial-updates-*)

Use of AI Tools

AI assistance: Implementation was planned with assistance from Claude Code (Anthropic). All code was reviewed, tested, and validated.

Testing Instructions

  1. Install and activate the plugin
  2. Go to Settings → AI and enable experiments globally
  3. Enable Editorial Notes and Editorial Updates experiments
  4. Open any post in the block editor
  5. Open the document settings sidebar (top-right gear icon)
  6. Click "Generate Editorial Notes" — wait for processing to complete
  7. Once done, the sidebar shows a suggestion count and Notes are attached to blocks
  8. Click "Editorial Updates" — this applies the editorial feedback directly to the block content
  9. Verify the block content updates to reflect the suggested changes

Screenshots or screencast

Before After
Screenshot 2026-05-08 at 11 29 20 PM Screenshot 2026-05-08 at 11 27 32 PM

Changelog Entry

Changed - Rename "Review Notes" experiment to "Editorial Notes" and "Refine from Notes" experiment to "Editorial Updates" (#506).

Open WordPress Playground Preview

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 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: zeus2611 <n1schay@git.wordpress.org>
Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>
Co-authored-by: saarnilauri <laurisaarni@git.wordpress.org>

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

zeus2611 added 3 commits May 9, 2026 20:36
Review Notes → Editorial Notes, Refine Notes → Editorial Updates.
Full rename: PHP namespaces, class names, feature slugs, DB option keys,
Webpack entries, TS source dirs, REST ability routes, plugin IDs,
integration tests, E2E specs, mock fixtures, and docs.

V1_0_0 upgrade migration copies existing enabled-state options from
old keys to new keys on plugin upgrade.
@zeus2611 zeus2611 closed this May 9, 2026
@zeus2611 zeus2611 force-pushed the feature/issue-506-rename-editorial-notes branch from 67a22f0 to 6a02fe2 Compare May 9, 2026 15:10
@zeus2611 zeus2611 reopened this May 9, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 9, 2026

Codecov Report

❌ Patch coverage is 96.87500% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 72.19%. Comparing base (94f5d40) to head (02097a1).
⚠️ Report is 3 commits behind head on develop.

Files with missing lines Patch % Lines
includes/Admin/Upgrades/V1_0_0.php 90.00% 1 Missing ⚠️
Additional details and impacted files
@@              Coverage Diff              @@
##             develop     #528      +/-   ##
=============================================
+ Coverage      71.20%   72.19%   +0.99%     
- Complexity      1150     1154       +4     
=============================================
  Files             67       68       +1     
  Lines           5563     5571       +8     
=============================================
+ Hits            3961     4022      +61     
+ Misses          1602     1549      -53     
Flag Coverage Δ
unit 72.19% <96.87%> (+0.99%) ⬆️

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.

@saarnilauri
Copy link
Copy Markdown
Contributor

Thanks for taking this on @zeus2611 My plan was to do things in a similar manner. Happy to defer to this PR; would just leave a few suggestions for consideration:

1. Experiment + button descriptions still describe the old behaviour. The load_metadata() descriptions and the in-editor buttonDescription strings were left at their original wording, so the settings card and sidebar still say "Reviews post content…" / "Analyze feedback that has been left via Notes…" / "Automatically updates blocks using unresolved feedback Notes." Some suggested replacements that match the new naming:

  • Editorial Notes description: Adds editorial suggestions to posts block-by-block, covering Accessibility, Readability, Grammar, and SEO. Requires an AI connector that includes support for text generation models.
  • Editorial Updates description: Applies pending editorial Notes to your content automatically. Requires an AI connector that includes support for text generation models. (Currently this one is also notably terse compared to the others in the settings list.)
  • EditorialNotesPlugin buttonDescription: This analyzes the content of this post block-by-block and adds editorial Notes with suggestions on each block.
  • EditorialUpdatesPlugin buttonDescription: Automatically applies pending editorial Notes to update your content.

2. "Editorial Updates" button label. Right now the button reads Editorial Updates, identical to the section heading and to the experiment label in settings. The button directly above it reads Generate Editorial Notes (verb-led). Consider Apply Editorial Updates so the two buttons share a verb-led shape and the button is clearly an action rather than a duplicate of the surrounding label.

3. useReviewBlockuseEditorialBlock rename is half-done. The hook itself was renamed, but the notice IDs inside it (ai_review_block_error) were not touched, so after this PR useEditorialBlock still dispatches under the old name. Either finishing the rename to ai_editorial_block_error or reverting the hook name back to useReviewBlock (treating it as a verb-action pair with reviewBlock) would make it internally consistent. No strong preference from me.

4. @since in V1_0_0.php. CONTRIBUTING.md asks for @since x.x.x on new code so release tooling can stamp the version. V1_0_0Test.php here follows that, but V1_0_0.php uses @since 1.0.0 literally on the class, the $version property, the upgrade() method, and the migrate_option() helper.

@dkotter and @jeffpaul might have their say on these 👆

Comment thread CHANGELOG.md Outdated
Comment on lines +6 to +7
### Changed
- Rename "Review Notes" experiment to "Editorial Notes" and "Refine from Notes" experiment to "Editorial Updates" ([#506](https://github.com/WordPress/ai/issues/506)).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

No need to add changelog entries here. We'll handle that as part of the release

@dkotter
Copy link
Copy Markdown
Collaborator

dkotter commented May 12, 2026

@SInCE in V1_0_0.php

Yeah, we like to keep these as x.x.x as we don't always know the version a PR will end up in. This is a more unique situation though as the class and file name itself includes the version number which is not something we generally look for in a search/replace prior to release.

The plan is to have this in v1.0.0 so I think fine to leave those as-is for now.

But I agree with all the feedback @saarnilauri gave above so once that's taken care of, I can do a final review here.

@jeffpaul jeffpaul added this to the 1.0.0 milestone May 12, 2026
@jeffpaul
Copy link
Copy Markdown
Member

Thanks @saarnilauri for those review comments, most seem accurate to me.

@zeus2611
Copy link
Copy Markdown
Contributor Author

Thanks @saarnilauri (and @dkotter, @jeffpaul) for the detailed review! All four points have been addressed:

  1. Descriptions updated — load_metadata() descriptions for both experiments and both buttonDescription strings in the plugin components now use the suggested copy exactly.
  2. Button label — The Editorial Updates button now reads Apply Editorial Updates (verb-led, consistent with Generate Editorial Notes).
  3. Notice ID — ai_review_block_error inside useEditorialBlock has been fully renamed to ai_editorial_block_error.
  4. @SInCE in V1_0_0.php — Leaving as 1.0.0 per @dkotter's guidance since the file is explicitly scoped to that version.

@dkotter would it be possible to do a review before syncing with develop? That way I can address any remaining feedback and resolve any new merge conflicts in one pass.

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.

Iterate Review Notes and Refine from Notes naming

4 participants