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

Created on 5 Mar 2021  路  5Comments  路  Source: angular/components

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

P2 a11y cda11y docs has pr

Most helpful comment

PR https://github.com/angular/components/pull/22136 fixes this, but looking into this uncovered a lot of other questions in COMP-164.

All 5 comments

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?

I will take a look.

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.

PR https://github.com/angular/components/pull/22136 fixes this, but looking into this uncovered a lot of other questions in COMP-164.

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jelbourn picture jelbourn  路  3Comments

MurhafSousli picture MurhafSousli  路  3Comments

kara picture kara  路  3Comments

julianobrasil picture julianobrasil  路  3Comments

Hiblton picture Hiblton  路  3Comments