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

x/pkgsite: header structure on Details Page differs from tree outline #41107

Open
jba opened this issue Aug 28, 2020 · 0 comments
Open

x/pkgsite: header structure on Details Page differs from tree outline #41107

jba opened this issue Aug 28, 2020 · 0 comments

Comments

@jba
Copy link
Contributor

@jba jba commented Aug 28, 2020

On Package Details page, <ul role="tree" aria-label="Outline">…</ul> suggests that all headers within <div class="js-docContent"> are structurally equal. Right now, most headers are <h3> and so are marked as subsections of Overview <h2 tabindex="-1" id="pkg-overview" class="Documentation-overviewHeader">…</h2>. If these are not subsections of overview, they should also be <h2>. Additionally, the <ul role="tree" aria-label="Outline">…</ul> suggests that there is a logical grouping for Functions and Types which is not reflected as headers. Functions and Types should be added as header, <h2> if equal to Overview, or <h3> if subsections of Overview. Individual Functions and Types in the package should be grouped as subsections of the new headers, with either <h3> or <h4> tags depending on the heading level of their parent section. For consistency with the UL, my recommendation is for Overview, Examples, Constants, Variables, Functions and Types to be <h2> and individual functions and types to be marked as <h3> subsections of their parent headers.

@jba jba added this to the pkgsite/frontend milestone Aug 28, 2020
@julieqiu julieqiu removed the UX label Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.