Repository navigation
docs: redesign the README - #130
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.