-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Discussion: Organizing the presentation of the requirements #1
Comments
Hi, In my opinion it is more advantageous to order them by sections, also because they are all necessary! |
They are mostly alphabetical now.
This list has no heading for Security (escaping all the things), so I assume it's in one of the other sections. |
Also, we should take into account the coding standards (https://github.com/WPTRT/WPThemeReview). The WordPress CS follow structure and logic from the official handbook. We've also organized our namespace in a similar way (grouping certain logic from the required sections). So it would be good to take this into consideration. |
@dingo-d I did look at it but because there are so few sniffs compared to the number of sections and requirements I did not find it helpful. |
We should work towards unifying this. Sniffs do follow rules in the requirement pages. And there are a lot of issues that will need to be categorized properly. |
Currently, all requirements are listed on one page:
https://make.wordpress.org/themes/handbook/review/required/
With the exception of requirements from Theme Check, which are listed here:
https://make.wordpress.org/themes/handbook/review/required/theme-check-plugin/
Current presentation
The requirements are divided into the following sections:
-It can be difficult to find the requirement if it is not listed in the section you expect it to be in.
Are there any benefits of sorting them by priority instead of in sections?
Should we separate code quality from license and upselling?
-Right now, it is a mix of what you can't do with code, what you can't do on your own website,
and what you can't do with your account.
Discoverability of the examples
Some requirements have examples.
Users still find it hard to find the example they are looking for.
These were moved from a separate page into the requirements
page because very few people could find the examples page.
The examples only show when you use the example toggle.
We decided to hide the examples because we thought the requirements
page would be to big if the examples were visible at all times.
But this means that the text is hidden from the on-page search.
The text was updated successfully, but these errors were encountered: