ToC rendering in new theme is hard to read

RESOLVED FIXED

Status

RESOLVED FIXED
5 years ago
5 years ago

People

(Reporter: canuckistani, Unassigned)

Tracking

Details

(Whiteboard: [specification][type:bug])

Attachments

(3 attachments)

What did you do?
================
The way in which the new theme provides a nexted table of contents block looks pretty bad, for example:

https://developer.mozilla.org/en-US/User:wbamberg/Add-ons/SDK/High-Level_APIs/tabs#isPinned_.3A_boolean

The way the bullets are rendered us much worse than the indented tree style of indentation used previously, or in the Add-on SDK docs.

What happened?
==============
The ToC structure is rendered as if it is the table of contents in a reference book

What should have happened?
==========================
The tablje of contents should preserve the established indented / nested look from both the previous MDN theme *and* the SDK docs which are the source for the material in the page I linked to.

Is there anything else we should know?
======================================
Created attachment 8340157 [details]
toc in the new theme - hard to read
Created attachment 8340158 [details]
toc rendered with the original MDN theme
Created attachment 8340159 [details]
toc rendered in the Add-on SDK docs
Summary: ToC rendering in new theme is terrible → ToC rendering in new theme is hard to read
Blocks: 928583
There are a few bugs discussing this, but I don't remember which ones they are. Holly can you link them here?

David - how much work is it to run an A/B test w/ optimizely to give the ToC an indented tree style?
Flags: needinfo?(hhabstritt.bugzilla)
Flags: needinfo?(dwalsh)
TOC related bugs I have been cc'd on:

TOC should indent subheadings
https://bugzilla.mozilla.org/show_bug.cgi?id=914797

TOC doesn't work when <h3> without <h2>
https://bugzilla.mozilla.org/show_bug.cgi?id=916444

The fact the TOC is collapsable is hardly discoverable
https://bugzilla.mozilla.org/show_bug.cgi?id=916042
Flags: needinfo?(hhabstritt.bugzilla)
Not long to A/B test but if it's something that's been complained about forever we should just pick a solution to run with.  It sounds like the current style set upsets people.
Flags: needinfo?(dwalsh)
Making a call based on discussion in mdn-drivers [1]:

Take out the numbers (this bug), restore the indentation (bug 914797). We can do them both in a single commit, and see if that also fixes bug 916444.

[1] https://groups.google.com/d/msg/mozilla.mdn.drivers/uaACdzCJKgg/yLlNTUCwDuIJ

Comment 8

5 years ago
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/9189ba2e8d196d027fb253ab191f556239626b9c
fix bug 947832, 944560, 937136, 914797, 914946 - Remove TOC counters and indent listing

https://github.com/mozilla/kuma/commit/ccfa5791f9471046c541dad989d456b276d99f1a
Merge pull request #1783 from darkwing/toc-spacing

fix bug 947832, 944560, 937136, 914797, 914946 - Remove TOC counters and indent listing

Updated

5 years ago
Status: NEW → RESOLVED
Last Resolved: 5 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.