Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#5017 closed enhancement (fixed)

Suggestion: move Explanation section higher up on DevHub pages

Reported by: valentinbora's profile valentinbora Owned by: coffee2code's profile coffee2code
Milestone: Priority: normal
Component: Developer Hub Keywords: 2nd-opinion


Most of the time the Explanation (frontend: More Information) section is used to provide Usage examples.

I believe this should be higher up, before Source, Changelog etc., so right underneath Parameter and Return.

Change History (12)

This ticket was mentioned in Slack in #docs by valentinbora. View the logs.

4 years ago

This ticket was mentioned in Slack in #meta by valentinbora. View the logs.

4 years ago

#3 @valentinbora
4 years ago

  • Keywords 2nd-opinion added

#4 @atachibana
4 years ago

This is important suggestion.

Ideally we should enhance the inline docs of functions or classes but header area is limited and not appropriate for long description and/or usage. We should move Explanation section higher as @valentinbora suggests (or, in ohter words, immediately after the returns.)

#5 @coffee2code
4 years ago

  • Owner set to coffee2code
  • Status changed from new to accepted

#6 @coffee2code
4 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 9822:

Developer theme: Move explanations (aka "More Information") higher up in page, immediately after Return.

Moves Source and Changelog sections to much later in the page.

Props valentinbora, atachibana, coffee2code.
Fixes #5017.

#7 @atachibana
4 years ago


Thank you so much! Your change made whole document useful and better than before!

#8 @joyously
4 years ago

The change for this ticket does not match the stated change. It says to move the More Information only, but what happened was the Source and Changelog were moved down the page, instead of just moving the Information up.
I find it very confusing now to see Related before the Source.
The Source needs to be close to the Parameters, so there is not so much scrolling back and forth.
Perhaps the More Information should be first.
But Related makes no sense before the Source.

This ticket was mentioned in Slack in #docs by joyously. View the logs.

4 years ago

#10 @atachibana
4 years ago


I agree what @joyously says. Related section is not so useful and too long than Source section.
How about moving Source section immediately after More Information section?

fyi. please refer below two types

No More Information:

With More Information:

#11 @coffee2code
4 years ago

In 9981:

Developer theme: Move source section to just after the explanation on code reference pages.

Props joyously, atachibana.
See #5017.

This ticket was mentioned in Slack in #docs by atachibana. View the logs.

4 years ago

Note: See TracTickets for help on using tickets.