doc, tools: add ARIA landmarks to API docs by Trott · Pull Request #49882 · nodejs/node

Trott · 2023-09-26T17:57:07Z

As an a11y enhancement, supply ARIA landmarks for all content.

nodejs-github-bot · 2023-09-26T17:57:11Z

Review requested:

@nodejs/website

nodejs-github-bot · 2023-09-26T18:28:01Z

CI: https://ci.nodejs.org/job/node-test-pull-request/54262/

Trott · 2023-09-26T18:28:27Z

@nodejs/nodejs-website

AugustinMauroy

I think use html semantic tags instead of role aria it's better and more logical.
But that's not really a problem.
REF:

Trott · 2023-09-26T19:00:27Z

I think use html semantic tags instead of role aria it's better and more logical. But that's not really a problem. REF:
* https://developer.mozilla.org/en-US/docs/Glossary/Semantics

* https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles

Sure, but that risks altering styling in unexpected ways and requiring more significant changes to html.mjs and/or allhtml.mjs. This is the minimal change. If you or someone else want to go in and try to update things to use semantic elements later, that's fine. But I won't be doing it in this PR. Small incremental changes FTW.

AugustinMauroy

LGTM 👍 !

ovflowd · 2023-09-26T19:16:29Z

I think use html semantic tags instead of role aria it's better and more logical. But that's not really a problem. REF:
* https://developer.mozilla.org/en-US/docs/Glossary/Semantics

* https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles
Sure, but that risks altering styling in unexpected ways and requiring more significant changes to html.mjs and/or allhtml.mjs. This is the minimal change. If you or someone else want to go in and try to update things to use semantic elements later, that's fine. But I won't be doing it in this PR. Small incremental changes FTW.

Oh no, let's please not update this old hacky HTML template. Only lord knows what would break.

There's pending work for redesigning the API docs (based on the new Figma's and work of the Website Redesign) which will result on the tooling behind the API docs to get a refresh (not related to the API metadata proposal, but I want to tackle the current API tooling since a long time ago)

nodejs-github-bot · 2023-09-27T15:37:23Z

CI: https://ci.nodejs.org/job/node-test-pull-request/54299/

nodejs-github-bot · 2023-09-28T04:59:35Z

CI: https://ci.nodejs.org/job/node-test-pull-request/54313/

nodejs-github-bot · 2023-09-28T18:08:36Z

Commit Queue failed

- Loading data for nodejs/node/pull/49882
✔  Done loading data for nodejs/node/pull/49882
----------------------------------- PR info ------------------------------------
Title      doc, tools: add ARIA landmarks to API docs (#49882)
Author     Rich Trott  (@Trott)
Branch     Trott:docs-a11y -> nodejs:main
Labels     doc, tools, commit-queue-rebase
Commits    3
 - doc: add navigation ARIA landmark to doc ToC
 - doc: add main ARIA landmark to API docs
 - tools: add navigation ARIA landmark to generated API ToC
Committers 1
 - Rich Trott 
PR-URL: https://github.com/nodejs/node/pull/49882
Reviewed-By: Luigi Pinca 
Reviewed-By: Claudio Wunder 
Reviewed-By: LiviaMedeiros 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/49882
Reviewed-By: Luigi Pinca 
Reviewed-By: Claudio Wunder 
Reviewed-By: LiviaMedeiros 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Tue, 26 Sep 2023 17:57:07 GMT
   ✔  Approvals: 3
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/49882#pullrequestreview-1644901184
   ✔  - Claudio Wunder (@ovflowd): https://github.com/nodejs/node/pull/49882#pullrequestreview-1645025930
   ✔  - LiviaMedeiros (@LiviaMedeiros): https://github.com/nodejs/node/pull/49882#pullrequestreview-1645859889
   ✘  Last GitHub CI failed
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/6342605819

As an accessibility improvement, specify the navigation landmark for the column in our docs that contains the table of contents. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the main landmark for the column in our docs that contains the main content. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the element of our docs that contains the table of contents generated for the specific API page. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

Trott · 2023-09-28T21:09:59Z

Landed in e97d256...7f06c27

As an accessibility improvement, specify the navigation landmark for the column in our docs that contains the table of contents. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the main landmark for the column in our docs that contains the main content. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the element of our docs that contains the table of contents generated for the specific API page. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the column in our docs that contains the table of contents. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: #49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the main landmark for the column in our docs that contains the main content. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: #49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the element of our docs that contains the table of contents generated for the specific API page. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: #49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the column in our docs that contains the table of contents. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the main landmark for the column in our docs that contains the main content. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the element of our docs that contains the table of contents generated for the specific API page. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: nodejs#49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the navigation landmark for the column in our docs that contains the table of contents. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: #49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

As an accessibility improvement, specify the main landmark for the column in our docs that contains the main content. Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/ Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html PR-URL: #49882 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org> Reviewed-By: LiviaMedeiros <livia@cirno.name>

Trott added the commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. label Sep 26, 2023

nodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Sep 26, 2023

Trott added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 26, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 26, 2023

This comment was marked as outdated.

Sign in to view

lpinca approved these changes Sep 26, 2023

View reviewed changes

Trott marked this pull request as draft September 26, 2023 18:15

Trott force-pushed the docs-a11y branch from 5ffad4a to b440e1c Compare September 26, 2023 18:22

This comment was marked as outdated.

Sign in to view

Trott marked this pull request as ready for review September 26, 2023 18:22

Trott added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 26, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 26, 2023

AugustinMauroy reviewed Sep 26, 2023

View reviewed changes

AugustinMauroy approved these changes Sep 26, 2023

View reviewed changes

ovflowd approved these changes Sep 26, 2023

View reviewed changes

Trott mentioned this pull request Sep 26, 2023

meta: update website team with new name #49883

Merged

mikeesto approved these changes Sep 27, 2023

View reviewed changes

aymen94 approved these changes Sep 27, 2023

View reviewed changes

LiviaMedeiros approved these changes Sep 27, 2023

View reviewed changes

github-actions bot mentioned this pull request Sep 28, 2023

CI Reliability 2023-09-28 nodejs/reliability#677

Open

19 tasks

Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 28, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 28, 2023

nodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Sep 28, 2023

Trott added 3 commits September 28, 2023 14:08

Trott force-pushed the docs-a11y branch from b440e1c to 7f06c27 Compare September 28, 2023 21:09

Trott merged commit 7f06c27 into nodejs:main Sep 28, 2023

Trott deleted the docs-a11y branch September 28, 2023 21:10

github-actions bot mentioned this pull request Sep 30, 2023

CI Reliability 2023-09-30 nodejs/reliability#679

Open

31 tasks

RafaelGSS mentioned this pull request Oct 9, 2023

2023-10-17, Version 21.0.0 (Current) #49870

Merged

targos mentioned this pull request Nov 12, 2023

v20.10.0 release proposal #50682

Merged

juanarbol mentioned this pull request Dec 6, 2023

2023-12-06, N|Solid v5.0.1 Iron Release nodesource/nsolid#41

Merged

github-actions bot mentioned this pull request Feb 18, 2025

2025-02-20, Version 18.20.7 'Hydrogen' (LTS) #57122

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc, tools: add ARIA landmarks to API docs#49882

doc, tools: add ARIA landmarks to API docs#49882
Trott merged 3 commits intonodejs:mainfrom
Trott:docs-a11y

Trott commented Sep 26, 2023

Uh oh!

nodejs-github-bot commented Sep 26, 2023

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Sep 26, 2023

Uh oh!

Trott commented Sep 26, 2023

Uh oh!

AugustinMauroy left a comment

Uh oh!

Trott commented Sep 26, 2023

Uh oh!

AugustinMauroy left a comment

Uh oh!

ovflowd commented Sep 26, 2023

Uh oh!

nodejs-github-bot commented Sep 27, 2023

Uh oh!

nodejs-github-bot commented Sep 28, 2023

Uh oh!

nodejs-github-bot commented Sep 28, 2023

Uh oh!

Trott commented Sep 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Uh oh!

Conversation

Trott commented Sep 26, 2023

Uh oh!

nodejs-github-bot commented Sep 26, 2023

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Sep 26, 2023

Uh oh!

Trott commented Sep 26, 2023

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Sep 26, 2023

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

ovflowd commented Sep 26, 2023

Uh oh!

nodejs-github-bot commented Sep 27, 2023

Uh oh!

nodejs-github-bot commented Sep 28, 2023

Uh oh!

nodejs-github-bot commented Sep 28, 2023

Uh oh!

Trott commented Sep 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants