WordPress.org

Making WordPress.org

Opened 3 years ago

Closed 15 months ago

#1847 closed enhancement (fixed)

Add short descriptions to Related section

Reported by: kevinwhoffman Owned by: obenland
Milestone: Priority: normal
Component: Developer Hub Keywords: has-patch has-screenshots
Cc:

Description

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.

Attachments (5)

related-with-short-descriptions_v01.jpg (166.0 KB) - added by kevinwhoffman 3 years ago.
Related section with proposed short descriptions
related-without-short-descriptions_v01.jpg (65.0 KB) - added by kevinwhoffman 3 years ago.
Existing Related section without short descriptions (related functions not shown either)
1847.patch (8.2 KB) - added by keesiemeijer 15 months ago.
Add short descriptions
1847.2.png (71.1 KB) - added by keesiemeijer 15 months ago.
full width
1847.3.png (84.1 KB) - added by keesiemeijer 15 months ago.
Before and after breakpoint for small screens

Download all attachments as: .zip

Change History (10)

@kevinwhoffman
3 years ago

Related section with proposed short descriptions

@kevinwhoffman
3 years ago

Existing Related section without short descriptions (related functions not shown either)

This ticket was mentioned in Slack in #meta-devhub by drew. View the logs.


3 years ago

#2 @obenland
16 months ago

  • Keywords needs-patch added

I'd love to see that actually

@keesiemeijer
15 months ago

Add short descriptions

#3 @keesiemeijer
15 months ago

  • Keywords has-patch has-screenshots added; needs-patch removed

In 1847.patch the short descriptions are added as suggested by @kevinwhoffman. The following screenshots shows how it looks with long file and function names. I took the screenshots with one zoom level up by mistake :-)

@keesiemeijer
15 months ago

full width

@keesiemeijer
15 months ago

Before and after breakpoint for small screens

#4 @kevinwhoffman
15 months ago

Thanks for bringing attention to this @obenland and for your work on the patch @keesiemeijer! I still think this would be a welcome addition, and the screenshots above look like it is headed in the right direction.

#5 @obenland
15 months ago

  • Owner set to obenland
  • Resolution set to fixed
  • Status changed from new to closed

In 7491:

DevHub: Add short descriptions to Related section

Props keesiemeijer, kevinwhoffman.
Fixes #1847.

Note: See TracTickets for help on using tickets.