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

docs(cdk/a11y): fix overview table of contents #22136

Merged
merged 1 commit into from
Mar 7, 2021
Merged

docs(cdk/a11y): fix overview table of contents #22136

merged 1 commit into from
Mar 7, 2021

Conversation

Splaktar
Copy link
Member

@Splaktar Splaktar commented Mar 7, 2021

  • 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

@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 added P2 The issue is important to a large percentage of users, with a workaround docs This issue is related to documentation area: cdk/a11y labels Mar 7, 2021
@Splaktar Splaktar self-assigned this Mar 7, 2021
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Mar 7, 2021
@Splaktar Splaktar mentioned this pull request Mar 7, 2021
Closed
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 7, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
4cb60bc 
- fix invalid usage of @Breaking-Change
- fix a couple of API doc typos

Relates to angular#18201. Relates to angular#22136.
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 7, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
8f3c9b6 
- fix invalid usage of `@breaking-change`
- fix a couple of API doc typos

Relates to angular#18201. Relates to angular#22136.
@Splaktar Splaktar mentioned this pull request Mar 7, 2021
Merged
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 7, 2021
@Splaktar
fix(cdk/a11y): add ConfigurableFocusTrapConfig to the public API
f21e8ef 
- `ConfigurableFocusTrap` is already in the public API and it depends on this class
- fix alphabetization of exports

Relates to angular#18201. Relates to angular#22136.
@Splaktar Splaktar mentioned this pull request Mar 7, 2021
Merged
@Splaktar Splaktar added the target: patch This PR is targeted for the next patch release label Mar 7, 2021
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 7, 2021
@Splaktar
fix(cdk/a11y): add ConfigurableFocusTrapConfig to the public API
60bcb1d 
- `ConfigurableFocusTrap` is already in the public API and it depends on this class
- fix alphabetization of exports

Relates to angular#18201. Relates to angular#22136.
crisbeto
crisbeto approved these changes Mar 7, 2021
View reviewed changes
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@crisbeto crisbeto added action: merge The PR is ready for merge by the caretaker merge safe labels Mar 7, 2021
@annieyw annieyw merged commit 4aa48a1 into angular:master Mar 7, 2021
annieyw pushed a commit that referenced this pull request 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 added a commit to DevIntent/components that referenced this pull request Mar 8, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
d43751b 
- fix invalid usage of `@breaking-change`
- fix a couple of API doc typos

Relates to angular#18201. Relates to angular#22136.
@Splaktar Splaktar deleted the docs-a11y-fix-headers branch March 8, 2021 00:50
@Splaktar
Copy link
Member Author

Splaktar commented Mar 8, 2021

Screen Shot 2021-03-07 at 19 53 06

This was referenced Mar 11, 2021
Closed
Merged
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 11, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
59969c5 
- fix invalid usage of `@breaking-change`
- fix a couple of API doc typos

Relates to angular#18201. Relates to angular#22136.
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 11, 2021
@Splaktar
fix(cdk/a11y): add ConfigurableFocusTrapConfig to the public API
186df51 
- `ConfigurableFocusTrap` is already in the public API and it depends on this class
- convert `ConfigurableFocusTrapConfig` from a class to an interface
- fix alphabetization of exports

Relates to angular#18201. Relates to angular#22136.
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 11, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
5f43efd 
- fix invalid usage of `@breaking-change`
- update breaking change dgeni template to add 'or later'
- fix a couple of API doc typos

Relates to angular#18201. Relates to angular#22136.
Splaktar added a commit to DevIntent/components that referenced this pull request Mar 11, 2021
@Splaktar
fix(cdk/a11y): add ConfigurableFocusTrapConfig to the public API
3fb4d91 
- `ConfigurableFocusTrap` is already in the public API and it depends on this class
- convert `ConfigurableFocusTrapConfig` from a class to an interface
- fix alphabetization of exports

Relates to angular#18201. Relates to angular#22136.
This was referenced Mar 12, 2021
Merged
Merged
Closed
Merged
Closed
andrewseguin pushed a commit that referenced this pull request Mar 19, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly (#22137
c0286ea 
)

- fix invalid usage of `@breaking-change`
- update breaking change dgeni template to add 'or later'
- fix a couple of API doc typos

Relates to #18201. Relates to #22136.
andrewseguin pushed a commit that referenced this pull request Mar 19, 2021
@Splaktar @andrewseguin
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly (#22137
032c4e4 
)

- fix invalid usage of `@breaking-change`
- update breaking change dgeni template to add 'or later'
- fix a couple of API doc typos

Relates to #18201. Relates to #22136.

(cherry picked from commit c0286ea)
andrewseguin pushed a commit that referenced this pull request Mar 19, 2021
@Splaktar
fix(cdk/a11y): add ConfigurableFocusTrapConfig to the public API (#22138
7718947 
)

- `ConfigurableFocusTrap` is already in the public API and it depends on this class
- convert `ConfigurableFocusTrapConfig` from a class to an interface
- fix alphabetization of exports

Relates to #18201. Relates to #22136.
@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.
Reviewers

@crisbeto crisbeto crisbeto approved these changes

@mmalerba mmalerba Awaiting requested review from mmalerba

@devversion devversion Awaiting requested review from devversion

@jelbourn jelbourn Awaiting requested review from jelbourn

Assignees

@Splaktar Splaktar

Labels
action: merge The PR is ready for merge by the caretaker area: cdk/a11y cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround target: patch This PR is targeted for the next patch release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

bug(docs): Overview Content of a11y package is random headings
3 participants
@Splaktar @crisbeto @annieyw