Skip to content

Improve README documentation clarity #2341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Atharv7248 wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open

Improve README documentation clarity #2341

Atharv7248 wants to merge 3 commits into from
+3 −3

Conversation

@Atharv7248
Copy link

@Atharv7248 Atharv7248 commented Jan 12, 2026

Summary

Fixes #

Relevant technical choices

Use of AI Tools

@github-actions
Copy link

github-actions bot commented Jan 12, 2026 •
edited
Loading

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @Atharv7248.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Unlinked contributors: Atharv7248.

Co-authored-by: mukeshpanchal27 <[email protected]>
Co-authored-by: westonruter <[email protected]>

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

westonruter
westonruter reviewed Jan 12, 2026
View reviewed changes
@westonruter westonruter added [Type] Enhancement A suggestion for improvement of an existing feature [Type] Documentation Documentation to be added or enhanced skip changelog PRs that should not be mentioned in changelogs no milestone PRs that do not have a defined milestone for release and removed [Type] Enhancement A suggestion for improvement of an existing feature labels Jan 14, 2026
mukeshpanchal27
mukeshpanchal27 reviewed Jan 30, 2026
View reviewed changes
@westonruter @mukeshpanchal27
Restore straight quote
993dbee 
Co-authored-by: Mukesh Panchal <[email protected]>
adamsilverstein
adamsilverstein reviewed Feb 1, 2026
View reviewed changes
README.md
For WordPress and PHP version requirements, please refer to the [CONTRIBUTING.md file](https://github.com/WordPress/performance/blob/trunk/CONTRIBUTING.md).

The feature plugins that are currently included in this plugin are:
The feature plugins which are currently featured by this plugin are:
Copy link
Member

@adamsilverstein adamsilverstein Feb 1, 2026

Choose a reason for hiding this comment

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

nit: feature...featured sounds redundant. included or bundled or provided?

Copy link
Member

@westonruter westonruter Feb 2, 2026

Choose a reason for hiding this comment

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

How about “highlighted”?

Suggested change
The feature plugins which are currently featured by this plugin are:
The feature plugins which are currently highlighted by this plugin are:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@westonruter westonruter westonruter left review comments

@adamsilverstein adamsilverstein adamsilverstein left review comments

@mukeshpanchal27 mukeshpanchal27 mukeshpanchal27 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

no milestone PRs that do not have a defined milestone for release skip changelog PRs that should not be mentioned in changelogs [Type] Documentation Documentation to be added or enhanced

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Atharv7248 @westonruter @adamsilverstein @mukeshpanchal27