kuma icon indicating copy to clipboard operation
kuma copied to clipboard

Suggestion for improving JS/API sidebars — add labels to indicate page types.

Open chrisdavidmills opened this issue 5 years ago • 0 comments

@valango commented on Fri Sep 25 2020

Request type

  • [ ] Please close this issue, I accidentally submitted it without adding any details
  • [ ] New documentation
  • [x] Correction or update

Details

The left-side navigation column at (https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript) is somewhat confusing for people not experienced in Javascript - labels for constuctors, interfaces and global object instances/namespaces all look the same.

Perhaps it would be helpful to have a "type tag" next to object name, like below (do not mind the bullets in the left):

Almost everything is an object in Javascript, so the current presentation is correct, of course. Adding some specifics would just make it a little more helpful for newbies.

Sorry, I am newbie myself to the Wiki editor, so could not find the right place to make those changes. ;)


@chrisdavidmills commented on Mon Sep 28 2020

I like this idea, but we don't have the capacity to look into it now. I'm going to transfer this to the Kuma (MDN platform) repo, and we can hopefully put it the backlog to consider as we redesign sidebars in the next iteration of MDN.

chrisdavidmills avatar Sep 28 '20 10:09 chrisdavidmills