Skip to content

docs(readme): directory listing tags, short description, screenshots - #73

Merged
ABB65 merged 1 commit into
mainfrom
docs/wporg-listing
Oct 29, 2026
Merged

ABB65 merged 1 commit into
mainfrom
docs/wporg-listing

Conversation

@ABB65

@ABB65 ABB65 commented Oct 29, 2026

Copy link
Copy Markdown
Member

Readme changes for the WordPress.org directory listing. Readme only; no code change, so it can go into the 0.8.4 tag as well.

  • Tags: markdown, export, static site, headless, astro (was export, migration, headless, astro, content). "migration" mostly draws people moving a whole WordPress site between hosts.
  • Short description: names what is exported (posts, pages, media, ACF fields) and where it goes (ZIP or GitHub). 142 characters.
  • One sentence after the media paragraph pointing to Contentrain Migrate, stated as a separate paid service that connects with a key the site owner creates. The link carries utm_source=wordpress-org&utm_medium=readme.
  • New == Screenshots == section for the four directory screenshots: steps 1–3 and the coverage report.

The display name and the in-plugin Migrate link change go into 0.8.5: the directory name comes from the plugin header, and Plugin Check warns (mismatched_plugin_name) when readme and header differ.

Checks: npm run test:plugin gives 0 errors, 1 warning. The warning is unexpected_markdown_file for CODE_OF_CONDUCT.md, from #72. tools/package.py does not package that file.

Supersedes: nothing.

Tags now match what people search for (markdown, static site) instead of
migration, which draws whole-site migration traffic. The short description
names what is exported and where it goes. A Screenshots section describes
the four directory screenshots (three steps and the coverage report), and
one sentence points to Contentrain Migrate as a separate paid service.
@ABB65
ABB65 merged commit 70617e1 into main Oct 29, 2026
9 checks passed
@ABB65
ABB65 deleted the docs/wporg-listing branch October 29, 2026 18:49
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