Skip to content

docs: redesign the README - #130

Merged
mpge merged 1 commit into
mainfrom
docs/readme-redesign
Nov 13, 2026
Merged

mpge merged 1 commit into
mainfrom
docs/readme-redesign

Conversation

@mpge

@mpge mpge commented Nov 13, 2026

Copy link
Copy Markdown
Member

Rewrites the README in the shared product-first layout: logo header, ticket list screenshot, two feature rows, a 3-column features grid listing every feature, a built-with row, a quick start from the release zip and a Learn more list.

This plugin renders wp-admin screens, not the shared Vue UI, so the images are its own Playwright screenshots in screenshots/results/ (light only).

Removed sections moved verbatim into docs/ (features, screenshots, installation, customization, rest-api, inbound-email, operations, development, newsletters). All 13 translations regenerated.

Note: readme.txt (WordPress.org) still documents [escalated_portal] and [escalated_guest_form] shortcodes, which the code no longer registers; left unchanged here.

Shorter, product-first README: shared header, the plugin's own wp-admin
screenshots as hero and feature rows, a features grid covering every
feature, a built-with row, the release-zip quick start and a link list
into docs/.

Removed README sections moved verbatim into docs/:
- Features -> docs/features.md
- Screenshots -> docs/screenshots.md
- Download, Requirements, Installation -> docs/installation.md
- Embedding the admin, Frontend Shortcodes, Ticket subjects,
  Custom Ticket Actions, Translations -> docs/customization.md
- REST API, Ticket merge -> docs/rest-api.md
- Inbound Email Webhooks -> docs/inbound-email.md
- Scheduled Tasks (WP-Cron), Database connection -> docs/operations.md
- Development -> docs/development.md
- Newsletters -> docs/newsletters.md

All 13 translated READMEs are regenerated from the new English README.
@mpge
mpge merged commit e85f516 into main Nov 13, 2026
3 checks passed
@mpge
mpge deleted the docs/readme-redesign branch November 13, 2026 05:47
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