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.

Sign up for GitHub

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

Jump to bottom

bug(docs): Overview Content of a11y package is random headings #22133

Closed
twerske opened this issue Mar 5, 2021 · 6 comments · Fixed by #22136
Closed

bug(docs): Overview Content of a11y package is random headings #22133

twerske opened this issue Mar 5, 2021 · 6 comments · Fixed by #22136
Assignees
@Splaktar
Labels
Accessibility This issue is related to accessibility (a11y) area: cdk/a11y docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround

Comments

@twerske
Copy link
Collaborator

twerske commented Mar 5, 2021 •
edited by Splaktar
Loading

Reproduction

Steps to reproduce:

  1. https://material.angular.io/cdk/a11y/overview

overview menu of a11y docs

Expected Behavior

Overview should show the a11y tools available:
ListKeyManager

  • Example

FocusTrap

  • Example

InteractivityChecker

  • Example
    etc

Actual Behavior

Overview is a mixture of headers from the different a11y tooling. Markdown may be tagged wrong?

Environment

v11 docs site
@twerske twerske added the needs triage This issue needs to be triaged by the team label Mar 5, 2021
@jelbourn jelbourn added Accessibility This issue is related to accessibility (a11y) docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround area: dev-infra Issue related to internal project infrastructure and removed needs triage This issue needs to be triaged by the team labels Mar 5, 2021
@jelbourn
Copy link
Member

jelbourn commented Mar 5, 2021

Something is definitely weird with how the TOC is being generated. Might be related to #21751. @Splaktar want to take a look since you dealt with this recently?

@Splaktar
Copy link
Member

Splaktar commented Mar 5, 2021

I will take a look.

@Splaktar
Copy link
Member

Splaktar commented Mar 7, 2021

It looks like this was messed up when more content was added in v6. Here's the v5 site: https://v5.material.angular.io/cdk/a11y/overview.

@Splaktar Splaktar added has pr and removed area: dev-infra Issue related to internal project infrastructure labels Mar 7, 2021
Splaktar added a commit to DevIntent/components that referenced this issue Mar 7, 2021
@Splaktar
docs(cdk/a11y): fix overview table of contents
54cc3ee 
- while the guides were updated to support a wider set of headers,
  component docs are still limited to h3 and h4 in the TOC
- this fixes a regression to these docs introduced in v6

Fixes angular#22133
@Splaktar Splaktar mentioned this issue Mar 7, 2021
Merged
@Splaktar
Copy link
Member

Splaktar commented Mar 7, 2021 •
edited
Loading

PR #22136 fixes this, but looking into this uncovered a lot of other questions in COMP-164.

annieyw pushed a commit that referenced this issue Mar 7, 2021
@Splaktar
docs(cdk/a11y): fix overview table of contents (#22136)
4aa48a1 
- while the guides were updated to support a wider set of headers,
  component docs are still limited to h3 and h4 in the TOC
- this fixes a regression to these docs introduced in v6

Fixes #22133
annieyw pushed a commit that referenced this issue Mar 7, 2021
@Splaktar @annieyw
docs(cdk/a11y): fix overview table of contents (#22136)
a14c6fb 
- while the guides were updated to support a wider set of headers,
  component docs are still limited to h3 and h4 in the TOC
- this fixes a regression to these docs introduced in v6

Fixes #22133

(cherry picked from commit 4aa48a1)
@Splaktar
Copy link
Member

Splaktar commented Mar 8, 2021

Now that this has been merged and the docs-content generated, I can post a screenshot of what this will look after the docs site gets deployed the next time.

Screen Shot 2021-03-07 at 19 53 06

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Apr 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Splaktar Splaktar

Labels
Accessibility This issue is related to accessibility (a11y) area: cdk/a11y docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(cdk/a11y): fix overview table of contents DevIntent/components
3 participants
@jelbourn @Splaktar @twerske