Skip to content

docs: readme.txt accuracy + polish pass#25

Merged
odanree merged 1 commit into
mainfrom
docs/readme-accuracy-pass
Jun 10, 2026
Merged

docs: readme.txt accuracy + polish pass#25
odanree merged 1 commit into
mainfrom
docs/readme-accuracy-pass

Conversation

@odanree

@odanree odanree commented Jun 10, 2026

Copy link
Copy Markdown
Owner

Summary

Tightens the WP.org listing copy (which is sourced from `readme.txt`) so it matches what the plugin actually does in 1.0.8.

# Change Why
1 Installation step 3 + FAQ no longer say Settings > ODR Image Optimizer The admin moved out from under wp-admin Settings to its own top-level menu in 1.0.4. `class-core.php` uses `add_menu_page`, not `add_options_page` (class-core.php:151).
2 FAQ toggle list rewritten to match registered settings Old list named non-existent toggles ("Lazy Load Delivery" — actually a dropdown) and omitted the ones that do exist (compression level, WebP, auto-optimize). New list mirrors `Settings::register_setting` (class-settings.php:165-173).
3 Added missing 1.0.1 changelog entry `CHANGELOG.md` has [1.0.1] but `readme.txt` skipped from 1.0.0 → 1.0.2.
4 Added 1.0.8 `== Upgrade Notice ==` entry Lets the WordPress admin update screen call out the backup-path change to anyone upgrading from 1.0.7.
5 Removed `== Screenshots ==` section Was listing three captions for images we have not produced. WP.org renders captions blank when the `.wordpress-org/screenshot-N.png` files aren't there. Better to drop the section for now and add it back once banner/icon/screenshots land in `.wordpress-org/`.
6 Removed personal email from Credits `danhle@danhle.net` on a public plugin page → spam magnet. `https://danhle.net\` and the GitHub support links stay.
7 Hedged Performance Results Added "reference test site, mobile Lighthouse" qualifier + "real-world numbers will vary" footnote so the LCP/FCP/TBT/CLS callout stays punchy without reading as a guarantee.

Deploy plan

Because nothing in this PR changes the plugin code, bumping `Stable tag` to 1.0.9 just to ship a readme polish would be wasteful. Instead, after merge:

  1. Manually trigger `Deploy to WordPress.org` from the Actions tab via `workflow_dispatch`.
  2. The 10up action syncs `main` → SVN `trunk/` (which is what the WP.org listing reads from), notices `tags/1.0.8` already exists, and leaves it alone. The listing page picks up the new copy on its next CDN refresh.

Test plan

  • FAQ toggle list cross-checked against `register_setting` in `includes/admin/class-settings.php`.
  • Admin menu location cross-checked against `add_menu_page` call in `includes/class-core.php`.
  • 1.0.1 changelog entry matches the corresponding `## [1.0.1]` section in `CHANGELOG.md`.
  • Stable tag intentionally not bumped (still 1.0.8) — listing copy sync is via `workflow_dispatch`, not a tag push.

Fixes a handful of inaccuracies and rough edges that have been sitting on the WP.org listing:

1. Installation step 3 + 'Can I disable specific optimizations?' FAQ no longer say 'Settings > ODR Image Optimizer'. Since 1.0.4 the admin is a top-level menu (add_menu_page in class-core.php), not under WordPress's Settings menu.

2. The FAQ toggle list now matches what register_setting() actually exposes in includes/admin/class-settings.php (compression level, WebP, lazy-load strategy, auto-optimize, preload fonts, kill bloat, inline critical CSS) instead of an out-of-date inventory.

3. Adds the missing 1.0.1 entry in == Changelog == — it was in CHANGELOG.md but readme.txt jumped 1.0.0 → 1.0.2.

4. Adds a 1.0.8 entry under == Upgrade Notice == so users updating from 1.0.7 see the backup-path change in the admin update screen.

5. Removes the == Screenshots == section. The three captions referenced images we have not produced yet; better to omit the section until banner/icon/screenshots land in .wordpress-org/ than to render captions with no images.

6. Drops the personal email address (danhle@danhle.net) from Credits to avoid scraping the public plugin page for spam.

7. Adds a hedge under the Performance Results table noting the numbers are from the reference test site; lets the LCP/FCP/TBT/CLS callout stay punchy without sounding like a guarantee for every install.
@odanree odanree merged commit 7a0458b into main Jun 10, 2026
4 checks passed
odanree added a commit that referenced this pull request Jun 10, 2026
1.0.9 is a docs-only release that ships the listing-copy accuracy pass
from #25 plus a CI fix:

- Deploy workflow now reads 'Stable tag:' from readme.txt and passes
  it to the 10up action as VERSION. The action's default derivation
  uses GITHUB_REF, which under workflow_dispatch resolves to
  refs/heads/main and made the action try to write to
  tags/refs/heads/... — that's why the previous manual sync failed
  before committing to trunk. Reading from readme.txt works for both
  tag pushes and manual dispatches.

Plugin code is unchanged from 1.0.8.
odanree added a commit that referenced this pull request Jun 10, 2026
* release: 1.0.9 + fix workflow_dispatch deploy (#26)

1.0.9 is a docs-only release that ships the listing-copy accuracy pass
from #25 plus a CI fix:

- Deploy workflow now reads 'Stable tag:' from readme.txt and passes
  it to the 10up action as VERSION. The action's default derivation
  uses GITHUB_REF, which under workflow_dispatch resolves to
  refs/heads/main and made the action try to write to
  tags/refs/heads/... — that's why the previous manual sync failed
  before committing to trunk. Reading from readme.txt works for both
  tag pushes and manual dispatches.

Plugin code is unchanged from 1.0.8.

* release: 1.0.10 (re-ship of botched 1.0.9)

1.0.9 was tagged but never properly shipped: PR #26 (version bump +
workflow fix) was stacked on PR #25's branch and merged into that
branch instead of main. When #25's branch was auto-deleted after
merge, #26's merge commit was orphaned and never reached main. The
v1.0.9 tag was then cut against #25's merge commit, so trunk and
tags/1.0.9 both shipped with 'Stable tag: 1.0.8' inside — which is
why the listing page never updated.

This release cherry-picks the orphaned #26 commit onto main and bumps
to 1.0.10 so the readme polish + workflow fix actually go out. The
1.0.9 SVN tag stays in the directory as inert cruft; tag deletion
is non-trivial and pointless once Stable tag points away from it.

No code changes vs 1.0.8 — this is docs + CI only.
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