781638 - List of elements (like w3schools) in references

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: General, defect, P3)

Description

[David Bruant]

When reading the documentation of the <input> element, it should be easy to jump to any other HTML element. Same thing for CSS, JavaScript, SVG, MathML

Comment 1

[Jean-Yves Perrier [:teoli]]

This is one of our biggest navigability problem right now. Somebody told me she preferred W3Schools because it is easy to go from one element to another (same for CSS, JavaScript, SVG, MathML).

Also I think we may try to be creative on this navigability issue. (Though it is not easy).

Comment 2

[David Walsh :davidwalsh]

Back to docs platform.

Comment 3

[Jeremie Patonnier :Jeremie]

Just to mention, I made an experiment with template on this issue :
https://developer.mozilla.org/en-US/docs/Template:quicknav

It allow to add a show/hide navigation sidebar. However, A true solution to this bug requires an in deep UX work.

Comment 4

[Eric Shepherd [:sheppy]]

Yes, this would be nice to have. It will take some significant fiddling around to get it done and done right.

Comment 5

[John Karahalis [:openjck]]

One of the things that dochub.io does very well, I think.

http://dochub.io/#html/

Comment 6

[Florian Scholz (Open Web Docs)]

It was mentioned again at the summit that the navigation of w3schools is quicker than MDN.
But our quick links ftw!

This is now done for
CSS, see e.g: https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
MathML, see e.g. https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math

Could be a doc sprint topic to add quick navigation to:

* HTML
* SVG
* APIs
* JavaScript
* ... (other reference docs)

Comment 7

[Jean-Yves Perrier [:teoli]]

It is done in APIs too.

Comment 8

[Florian Scholz (Open Web Docs)]

Done for JS this year, too.
HTML, SVG elements have it as well.

SVG attributes:
https://bugzilla.mozilla.org/show_bug.cgi?id=658789

Closing here for now. File new bugs for other areas with navigation issues.