docs: rewrite readme.txt and add readme writing guide - #196
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Feature lines follow 'Name: what the user can do'. Free and Pro are separated, and requirements (API key, OAuth) are stated. External services and privacy facts are unchanged in substance. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Rewrites
readme.txtin plain, short sentences, following the Elementor readme's layout. Adds a "WordPress plugin readme writing" guide toCLAUDE.md(and so toAGENTS.md, which links to it).Why
The old readme was long, repeated itself and read like generated copy. The new guide keeps future edits to the same standard.
How
Open questions
Testing
This ships to WordPress.org on the next release, so it needs your review before merge.
🤖 Generated with Claude Code