Opened 8 years ago
Last modified 2 years ago
#2538 assigned feature request
Plugin Directory: Preview Readme
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Milestone: | Q2 | Priority: | high |
| Component: | Plugin Directory | Keywords: | has-patch dev-feedback |
| Cc: |
Description
It would be helpful for developers if they could proof their new readme, if a tag was in the directory already.
Example:
https://wordpress.org/plugins/akismet/?version=14.1 would display the plugin as if it was generated by the readme in the 14.1 tag folder.
If the tag doesn't exist, the default readme is shown.
Attachments (2)
Change History (12)
This ticket was mentioned in Slack in #meta by tellyworth. View the logs.
8 years ago
#5
@
5 years ago
- Keywords has-patch dev-feedback added; needs-patch removed
- Owner set to tellyworth
- Status changed from new to assigned
attachment:2538.diff implements a simple preview function on the Readme Validator page. It simply outputs the parsed readme below the validator status messages. There's no special styling, and it doesn't show screenshots.
#6
@
4 years ago
- Priority changed from low to high
I'm bumping the priority of this up a notch, as being able to preview/validate/understand how it's parsing a readme is actually fairly important.
Right now, the most feedback you get from the validator is absolute errors / missing fields, but it's easy to not understand it.
If we made the plugin validator display a preview, we could link to that. Displaying older readme content on the plugin page itself is unfortunately difficult.