Skip to content

docs: refresh wp.org readme copy and clean up changelog formatting - #1939

Merged
arifulhoque7 merged 1 commit into
weDevsOfficial:developfrom
arifulhoque7:docs/readme-wporg-refresh
Aug 12, 2026
Merged

docs: refresh wp.org readme copy and clean up changelog formatting#1939
arifulhoque7 merged 1 commit into
weDevsOfficial:developfrom
arifulhoque7:docs/readme-wporg-refresh

Conversation

@arifulhoque7

Copy link
Copy Markdown
Contributor

Refreshes the wp.org listing copy (plugin title, short description, Description body) and fixes formatting the wp.org readme parser mishandles.

Changes

  • Section levelsWhy Choose User Frontend and Perfect for Building demoted from == to =. As == they were parsed as separate top-level readme sections rather than Description subheadings.
  • Inline bold — normalised <strong> to Markdown **, matching the style already used in the Pro feature list.
  • Stray heading — removed the empty = = heading before Screenshots.
  • Changelog headings — dropped the v prefix (= v4.3.10 == 4.3.10 =) so headings match the released version numbers.
  • Changelog accuracy — 4.0.1/4.0.2/4.0.3 and 4.2.8 duplicated the entries of the release before them; collapsed into re-release notes. Fixed the escaped-emoji markup in the 4.1.8 typo entry.
  • Copy — external-services descriptions now describe WPUF's AI form generation instead of the project/task wording carried over from another plugin; corrected the Anthropic ToS link; fixed shortcdoe and main compatibility typos.
  • Added the missing trailing newline.

Short description is 141 chars (under the 150 limit). No ## Markdown headers, no CRLF.

Notes

  • No functional changes — readme.txt only.
  • The same content is being pushed directly to wp.org SVN (trunk + tags/4.3.10) so the live listing updates without waiting for a release; the wp.org page serves tags/<Stable tag>/readme.txt.

Rewrite the plugin title, short description and Description body for the
wp.org listing, and fix formatting the readme parser mishandled:

- Demote "Why Choose User Frontend" and "Perfect for Building" from `==`
  to `=`; as top-level sections they were parsed as separate readme
  sections instead of Description subheadings.
- Normalise inline bold to Markdown `**` (already used elsewhere in the
  file) and drop the stray empty `=  =` heading.
- Drop the `v` prefix from changelog version headings so they match the
  released version numbers.
- Collapse the duplicated 4.0.1-4.0.3 and 4.2.8 changelog entries into
  re-release notes, and fix the escaped-emoji markup in the 4.1.8 entry.
- Add the missing trailing newline.

No functional changes.
@arifulhoque7
arifulhoque7 merged commit b1a23de into weDevsOfficial:develop Aug 12, 2026
4 checks passed
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