GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc, tools: add ARIA landmarks to API docs by Trott · Pull Request #49882 · nodejs/node

Conversation

@Trott

@Trott Trott commented Sep 26, 2023

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Trott Trott added the commit-queue-rebase PRs the Commit Queue should land as multiple self-contained commits. label Sep 26, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 26, 2023

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/website
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. tools Issues and PRs related to the tools directory. labels Sep 26, 2023
@Trott Trott added the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Sep 26, 2023
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Sep 26, 2023
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
lpinca
lpinca approved these changes Sep 26, 2023
View reviewed changes
@Trott
Trott marked this pull request as draft September 26, 2023 18:15
@Trott
Trott force-pushed the docs-a11y branch from 5ffad4a to b440e1c Compare September 26, 2023 18:22
@Trott

This comment was marked as outdated.

Sign in to view
@Trott
Trott marked this pull request as ready for review September 26, 2023 18:22
@Trott Trott added the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Sep 26, 2023
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Sep 26, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 26, 2023

Copy link
Copy Markdown
Collaborator

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Trott

Trott commented Sep 26, 2023

Copy link
Copy Markdown
Member Author

@nodejs/nodejs-website
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
AugustinMauroy
AugustinMauroy reviewed Sep 26, 2023
View reviewed changes

@AugustinMauroy AugustinMauroy left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Trott

Trott commented Sep 26, 2023

Copy link
Copy Markdown
Member Author

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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
AugustinMauroy
AugustinMauroy approved these changes Sep 26, 2023
View reviewed changes

@AugustinMauroy AugustinMauroy left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM 👍 !

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@ovflowd

ovflowd commented Sep 26, 2023

Copy link
Copy Markdown
Member

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)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
ovflowd
ovflowd approved these changes Sep 26, 2023
View reviewed changes
@Trott Trott mentioned this pull request Sep 26, 2023
meta: update website team with new name #49883
Merged
mikeesto
mikeesto approved these changes Sep 27, 2023
View reviewed changes
aymen94
aymen94 approved these changes Sep 27, 2023
View reviewed changes
LiviaMedeiros
LiviaMedeiros approved these changes Sep 27, 2023
View reviewed changes
@nodejs-github-bot

nodejs-github-bot commented Sep 27, 2023

Copy link
Copy Markdown
Collaborator

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot mentioned this pull request Sep 28, 2023
CI Reliability 2023-09-28 nodejs/reliability#677
Open
19 tasks
@nodejs-github-bot

nodejs-github-bot commented Sep 28, 2023

Copy link
Copy Markdown
Collaborator

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Trott Trott added the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 28, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Sep 28, 2023
@nodejs-github-bot nodejs-github-bot added the commit-queue-failed PRs whose Commit Queue landing failed and need manual intervention before retrying. label Sep 28, 2023
@nodejs-github-bot

nodejs-github-bot commented Sep 28, 2023

Copy link
Copy Markdown
Collaborator
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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Trott added 3 commits September 28, 2023 14:08
@Trott
doc: add navigation ARIA landmark to doc ToC
f416a0f 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
@Trott
doc: add main ARIA landmark to API docs
bc056c2 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
@Trott
tools: add navigation ARIA landmark to generated API ToC
7f06c27 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
@Trott
Trott force-pushed the docs-a11y branch from b440e1c to 7f06c27 Compare September 28, 2023 21:09
@Trott
Trott merged commit 7f06c27 into nodejs:main Sep 28, 2023
@Trott

Trott commented Sep 28, 2023

Copy link
Copy Markdown
Member Author

Landed in e97d256...7f06c27
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Trott
Trott deleted the docs-a11y branch September 28, 2023 21:10
@github-actions github-actions Bot mentioned this pull request Sep 30, 2023
CI Reliability 2023-09-30 nodejs/reliability#679
Open
31 tasks
@RafaelGSS RafaelGSS mentioned this pull request Oct 9, 2023
2023-10-17, Version 21.0.0 (Current) #49870
Merged
targos pushed a commit that referenced this pull request Nov 11, 2023
@Trott @targos
doc: add navigation ARIA landmark to doc ToC
959ef7a 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
targos pushed a commit that referenced this pull request Nov 11, 2023
@Trott @targos
doc: add main ARIA landmark to API docs
337a676 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
targos pushed a commit that referenced this pull request Nov 11, 2023
@Trott @targos
tools: add navigation ARIA landmark to generated API ToC
732b566 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
@targos targos mentioned this pull request Nov 12, 2023
v20.10.0 release proposal #50682
Merged
@juanarbol juanarbol mentioned this pull request Dec 6, 2023
2023-12-06, N|Solid v5.0.1 Iron Release nodesource/nsolid#41
Merged
debadree25 pushed a commit to debadree25/node that referenced this pull request Apr 15, 2024
@Trott @debadree25
doc: add navigation ARIA landmark to doc ToC
c0826c7 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
debadree25 pushed a commit to debadree25/node that referenced this pull request Apr 15, 2024
@Trott @debadree25
doc: add main ARIA landmark to API docs
af6db5c 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
debadree25 pushed a commit to debadree25/node that referenced this pull request Apr 15, 2024
@Trott @debadree25
tools: add navigation ARIA landmark to generated API ToC
92295eb 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
aduh95 pushed a commit that referenced this pull request Feb 10, 2025
@Trott @aduh95
doc: add navigation ARIA landmark to doc ToC
6c4ce1f 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
aduh95 pushed a commit that referenced this pull request Feb 10, 2025
@Trott @aduh95
doc: add main ARIA landmark to API docs
4829d97 
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 <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
@github-actions github-actions Bot mentioned this pull request Feb 18, 2025
2025-02-20, Version 18.20.7 'Hydrogen' (LTS) #57122
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lpinca lpinca lpinca approved these changes
@ovflowd ovflowd ovflowd approved these changes
@LiviaMedeiros LiviaMedeiros LiviaMedeiros approved these changes
+3 more reviewers
@aymen94 aymen94 aymen94 approved these changes
@mikeesto mikeesto mikeesto approved these changes
@AugustinMauroy AugustinMauroy AugustinMauroy approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

commit-queue-failed PRs whose Commit Queue landing failed and need manual intervention before retrying. commit-queue-rebase PRs the Commit Queue should land as multiple self-contained commits. doc Issues and PRs related to Node.js documentation. tools Issues and PRs related to the tools directory.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

8 participants

@Trott @nodejs-github-bot @ovflowd @lpinca @aymen94 @mikeesto @LiviaMedeiros @AugustinMauroy
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.