Skip to content

docs: simplify the WordPress.org readme and title (#28) - #29

Open
ifahimreza wants to merge 2 commits into
mainfrom
docs/28-simplify-readme
Open

ifahimreza wants to merge 2 commits into
mainfrom
docs/28-simplify-readme

Conversation

@ifahimreza

@ifahimreza ifahimreza commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Closes #28

What

Rewrites readme.txt so the WordPress.org page is short and easy to skim, and gives the directory listing a plain title: Mailyard – Free SMTP with a Backup Provider (previously just "Mailyard").

Why

The page was long and dense: about 2,200 words above the changelog, with a story-style intro and multi-sentence FAQ answers. See #28. The tone and structure follow Meow Mailer.

How

  • Title: the directory takes its title from the readme's === … === line, so only the readme changes. The plugin header Plugin Name: Mailyard stays the same, which keeps the admin Plugins screen unchanged.
  • Short description: 125 characters (the limit is 150).
  • Description: 3 short paragraphs, 13 one-line features, then a provider list with a "which to pick" guide. The FAQ question about choosing a provider moved here, so it no longer appears twice.
  • External services: the disclosure covers the same services in a compact list. Every endpoint and every terms and privacy URL from the old readme is still there (checked by diffing the URLs). The only URL dropped and then added back was plugpress.co/mailyard.
  • FAQ: 10 questions, each answered in 1–3 sentences. The API-keys answer now also mentions encryption and wp-config.php (both shipped in 1.1.0).
  • About 2,220 → 1,370 words above the changelog. The Description section went from about 700 to about 400 words.
  • Not touched: the changelog (byte-identical), Version, Stable tag, tags and headers.

⚠️ Merging publishes

assets.yml copies readme.txt into SVN trunk and tags/1.1.0 on merge to main, so the live wordpress.org page updates right away. Per the merge policy (anything that ships to WordPress.org), this is waiting for your OK.

Testing

  • Plugin Check CI (validates the readme)
  • Changelog section byte-identical to main
  • No external-service URL removed
  • Tested on WP 7.0, PHP 8.2 (n/a, readme only)
  • Tested with the plugin's known conflict list (n/a)
  • No PHP notices/warnings with WP_DEBUG on (n/a)
  • Checked free vs pro gating still correct (n/a, no Pro)

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Directory title now says what the plugin does. Description is a short
intro plus a scannable feature list, FAQ answers are 1-3 sentences, and
External services is the same disclosure in a compact list. Changelog,
version and Stable tag are unchanged.

Refs #28

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@ifahimreza ifahimreza linked an issue Oct 9, 2026 that may be closed by this pull request
7 tasks
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.

docs(readme): simplify the WordPress.org readme and title

1 participant