Skip to content

docs: rewrite readme.txt and add readme writing guide - #196

Merged
ifahimreza merged 2 commits into
mainfrom
docs/readme-rewrite
Sep 23, 2026
Merged

ifahimreza merged 2 commits into
mainfrom
docs/readme-rewrite

Conversation

@ifahimreza

Copy link
Copy Markdown
Contributor

What

Rewrites readme.txt in plain, short sentences, following the Elementor readme's layout. Adds a "WordPress plugin readme writing" guide to CLAUDE.md (and so to AGENTS.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

  • Each feature line reads "Feature name: What the user can do."
  • Free and Pro features have separate sections. The API key, OAuth and account requirements are stated.
  • External services and privacy facts keep the same substance, including the precise update-check wording.
  • The 1.0.0 changelog is cut to "Initial release." The full notes stay in git history.
  • Version, Tested up to, tags and links are unchanged.

Open questions

  • The Pro section lists Yoast, Rank Math, AIOSEO and WooCommerce tools. They exist in saddle-pro code but aren't in Pro's own readme yet.
  • The ChatGPT FAQ says "Yes" and doesn't mention that Plus and Pro accounts are read-only for custom connectors.

Testing

  • Short description is 126 characters
  • No em dashes, no sentence of 20 words or more

This ships to WordPress.org on the next release, so it needs your review before merge.

🤖 Generated with Claude Code

ifahimreza and others added 2 commits September 24, 2026 05:20
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>
@ifahimreza
ifahimreza merged commit 465d4ef into main Sep 23, 2026
7 checks passed
@ifahimreza
ifahimreza deleted the docs/readme-rewrite branch September 23, 2026 23:21
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.

1 participant