[wp-meta] [Making WordPress.org] #1847: Add short descriptions to Related section

Making WordPress.org noreply at wordpress.org
Tue Jul 19 17:59:36 UTC 2016

#1847: Add short descriptions to Related section
 Reporter:  kevinwhoffman  |      Owner:
     Type:  enhancement    |     Status:  new
 Priority:  normal         |  Milestone:
Component:  Developer Hub  |   Keywords:
 **Problem:** When using the Code Reference to research a problem, the
 developer will often look to the Related section to track down its source.
 If the developer is not familiar with every related item, they must click
 into each one to discover its purpose.

 **Solution:** Adding a short description would immediately signal to the
 developer what the related item does without having to click into a
 separate page. The attached mockup would function like so:

 * Uses, Used By, and Related To would each have their own table under the
 Related heading.
 * Up to 5 related items would be visible on page load, with a show more
 toggle directly under each table as required.
 * The Short Description column could be hidden on mobile to maintain a
 clean UI.

 **Possible Concerns:** One concern might be the increase in vertical space
 required for this section. However, I believe the increased utility of the
 short descriptions is worth it. As the second-to-last section on the page,
 it will not affect the layout of the top sections. Furthermore by limiting
 the number of related items per table to 5 (as is the current behavior),
 the max height of the section can be limited.

Ticket URL: <https://meta.trac.wordpress.org/ticket/1847>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org

More information about the wp-meta mailing list