List of elements (like w3schools) in references

RESOLVED FIXED

Status

Developer Documentation
General
P3
normal
RESOLVED FIXED
5 years ago
3 years ago

People

(Reporter: David Bruant, Assigned: sheppy)

Tracking

Details

(Reporter)

Description

5 years ago
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
Component: Docs Platform → Documentation Requests
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).
Back to docs platform.
Component: Documentation Requests → Docs Platform
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.
(Assignee)

Comment 4

5 years ago
Yes, this would be nice to have. It will take some significant fiddling around to get it done and done right.
One of the things that dochub.io does very well, I think.

http://dochub.io/#html/
Summary: Consider having the list of elements (W3School-style) for reference elements → List of elements (like w3schools) in references
Priority: -- → P3
Version: Kuma → unspecified
Component: Docs Platform → Editing
Product: Mozilla Developer Network → Mozilla Developer Network
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)
Assignee: nobody → eshepherd
Component: Editing → General
Product: Mozilla Developer Network → Developer Documentation
It is done in APIs too.
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.
Status: NEW → RESOLVED
Last Resolved: 3 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.