Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement request to expose H3 headings in the page TOC #7198

Open
3 tasks done
dipikabh opened this issue Sep 20, 2022 · 2 comments
Open
3 tasks done

Enhancement request to expose H3 headings in the page TOC #7198

dipikabh opened this issue Sep 20, 2022 · 2 comments
Labels
effort: medium This task is a medium effort. enhancement Improves an existing feature. 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. idle p2 We want to address this but may have other higher priority items. sidebar/toc Sidebar and table of contents

Comments

@dipikabh
Copy link
Contributor

Summary

The case for the page TOC ("In this article") to additionally show H3 headings in the page has been made here mdn/mdn-community#162. There is a consensus on the requirement.

Opening this issue so that the engineering team can plan this task. This might also require design inputs as highlighted in the discussion.

URL

An example link: https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Cascade_and_inheritance

Reproduction steps

Any and all pages on MDN contain the in-page TOC with only the H2 headings

Expected behavior

Both H2 and H3 headings in the page TOC

Actual behavior

The page TOC shows the H2 headings

Device

Laptop

Browser

Firefox

Browser version

Stable

Operating system

Mac OS

Screenshot

No response

Anything else?

No response

Validations

@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Sep 20, 2022
@wbamberg
Copy link
Collaborator

If you don't mind: I'd like to suggest if possible that rather than collapsing H2s that contain H3s, we consider making the ToC scrollable.

In most scenarios (outside mobile, and maybe even there) I think we will comfortably fit a ToC that contains H3 headings, and having them all visible makes it much easier to find things than having to expand H2s looking for them. Then scrolling the ToC should be a fairly rare fallback when the ToC is actually too long.

@caugner caugner added enhancement Improves an existing feature. p2 We want to address this but may have other higher priority items. sidebar/toc Sidebar and table of contents and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Oct 24, 2022
@github-actions github-actions bot added the 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. label Nov 30, 2022
@github-actions github-actions bot added the idle label Dec 30, 2022
@wbamberg
Copy link
Collaborator

What is the status of this request, and how can it be triaged/moved foward?

I'm working on a page that discusses APIs that PWAs can use for background operation. It would make logical sense for some of the sections to be H3 headings, but that makes them non-discoverable in the current ToC implementation: mdn/content#25305 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: medium This task is a medium effort. enhancement Improves an existing feature. 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. idle p2 We want to address this but may have other higher priority items. sidebar/toc Sidebar and table of contents
Projects
None yet
Development

No branches or pull requests

3 participants