Opened 8 years ago
Closed 6 years 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)
Change History (10)
@
8 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.
8 years ago
#3
@
6 years 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 :-)
Related section with proposed short descriptions