DOCS: Accessibility update to comply with our accessibility legal requirements. #2185

Sam-Unity · 2025-05-20T06:51:22Z

Description

These are necessary changes made to images and their alt-text to comply with our accessibility legal requirements.

Testing status & QA

NA

Overall Product Risks

These are purely image and table changes made to docs and zero risk.

Comments to reviewers

Removal of redundant images is also part of the accessibility policy, which is why some were removed as text already contained the info.

Checklist

Before review:

Changelog entry added.
- Explains the change in Changed, Fixed, Added sections.
- For API change contains an example snippet and/or migration example.
- JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
- Jira port for the next release set as "Resolved".
Tests added/changed, if applicable.
- Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
- Performance tests.
- Integration tests.
Docs for new/changed API's.
- Xmldoc cross references are set correctly.
- Added explanation how the API works.
- Usage code examples added.
- The manual is updated, if needed.

During merge:

Commit message for squash-merge is prefixed with one of the list:
- NEW: ___.
- FIX: ___.
- DOCS: ___.
- CHANGE: ___.
- RELEASE: 1.1.0-preview.3.

After merge:

Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

unity-cla-assistant · 2025-05-20T06:51:27Z

All committers have signed the CLA.

codecov-github-com · 2025-05-20T07:06:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2185      +/-   ##
===========================================
- Coverage    65.45%   65.44%   -0.01%     
===========================================
  Files          367      367              
  Lines        53505    53505              
===========================================
- Hits         35024    35019       -5     
- Misses       18481    18486       +5

Flag	Coverage Δ
linux_2021.3_project	`70.41% <ø> (ø)`
linux_2022.3_project	`65.27% <ø> (ø)`
linux_6000.0_project	`65.35% <ø> (ø)`
linux_6000.1_project	`65.34% <ø> (ø)`
linux_trunk_project	`65.34% <ø> (-0.01%)`	⬇️
mac_2021.3_pkg	`5.41% <ø> (ø)`
mac_2021.3_project	`70.42% <ø> (ø)`
mac_2022.3_pkg	`5.19% <ø> (ø)`
mac_2022.3_project	`65.29% <ø> (ø)`
mac_6000.0_pkg	`5.20% <ø> (ø)`
mac_6000.0_project	`65.37% <ø> (-0.01%)`	⬇️
mac_6000.1_pkg	`5.20% <ø> (ø)`
mac_6000.1_project	`65.37% <ø> (ø)`
mac_trunk_pkg	`5.20% <ø> (ø)`
mac_trunk_project	`65.36% <ø> (ø)`
win_2021.3_pkg	`5.42% <ø> (ø)`
win_2021.3_project	`70.49% <ø> (ø)`
win_2022.3_pkg	`5.20% <ø> (ø)`
win_2022.3_project	`65.37% <ø> (ø)`
win_6000.0_pkg	`5.20% <ø> (ø)`
win_6000.0_project	`65.44% <ø> (ø)`
win_6000.1_pkg	`5.20% <ø> (ø)`
win_6000.1_project	`65.45% <ø> (ø)`
win_trunk_pkg	`5.20% <ø> (ø)`
win_trunk_project	`65.44% <ø> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jfreire-unity · 2025-05-21T08:30:13Z

Packages/com.unity.inputsystem/Documentation~/ProjectWideActions.md


 Once you have created and assigned project-wide actions, the Input System Package page in Project Settings displays the **Actions Editor** interface. Read more about how to use the [Actions Editor](ActionsEditor.md) to configure your actions.

-![image alt text](./Images/ProjectSettingsInputActionsSimpleShot.png)


Can you expand on why this has to be removed? It provides the reader with the expectation of what is described.

For UI images, documentation is moving away from providing screenshots of the UI if the information is provided in-text to lower upkeep needed to keep images updated with UI changes. In this case, the text itself leads to the UI reference page for the ActionsEditor, so users who want to know more would be going to that page and see a fully labelled version of the same image in greater detail, so it makes this screenshot slightly redundant.

jfreire-unity · 2025-05-21T08:31:18Z

Packages/com.unity.inputsystem/Documentation~/ProjectWideActions.md


 You can also delete all action maps, or reset all the actions back to the default values from the **more** (⋮) menu at the top right of the Input Actions section of the settings window, below the Project Settings window search field.

-![The Input Actions **more** menu as displayed in the Project Settings window](images/InputActionsSettingsMoreMenu.png)


Same question here.

Similar to above, for the majority of the screenshot doesn't provide relevant information that we want users to focus on, as the main thing is the highlighted location of the 'more' menu in red. But the location and icon is already described in the text.

In this case, alt-text provided in the image caption would become a repeat of what has already been said above by the adjacent/accompanying text, so the image is decorative.

However if you feel the image is still important, it can be restored and we'll leave the alt-text blank.

jfreire-unity

Looks good now. Thank you!

ekcoh

Looks good to me, just wondering if we shouldn't highlight the change in the CHANGELOG.md? Its non-functional, but still a relevant update/fix.

Pauliusd01

The text seems fine to me but I still see some CI failures, reran them

Pauliusd01 · 2025-05-22T11:54:40Z

Still see valid sounding failures for example:

playmode Test Failure: APIVerificationTests.API_DocumentationManualDoesNotHaveMissingOrUnusedImages

Images directory contains image files that are not referenced in any docs. Consider removing them:
 Workflow-Actions.png
 Workflow-Direct.png
 Workflow-PlayerInput.png

- Restored removed images (see #2185) - Added the image references back to the table on the Workflows landing page - Also replaced makeshift Notes and Tips with DocFx admonitions

Sam-Unity added 2 commits May 19, 2025 17:31

Removed decorative and redundant images for accessiblity

f2d48d7

Added alt text to image

a3a4dca

Pauliusd01 requested review from Pauliusd01 and ekcoh May 20, 2025 10:31

stefanunity changed the title ~~DOCS accessibility update~~ DOCS: accessibility update May 20, 2025

stefanunity and others added 2 commits May 20, 2025 13:02

fix formatting

56334d7

Merge branch 'develop' into docs-accessibility-update

a753105

jfreire-unity reviewed May 21, 2025

View reviewed changes

Readded images but blanked alt-text

de67395

Sam-Unity requested a review from jfreire-unity May 22, 2025 08:50

jfreire-unity approved these changes May 22, 2025

View reviewed changes

ekcoh approved these changes May 22, 2025

View reviewed changes

Pauliusd01 approved these changes May 22, 2025

View reviewed changes

Removing unused images

2578467

jfreire-unity changed the title ~~DOCS: accessibility update~~ DOCS: Accessibility update to comply with our accessibility legal requirements. May 27, 2025

jfreire-unity merged commit f42eb5e into develop May 27, 2025
110 of 113 checks passed

jfreire-unity deleted the docs-accessibility-update branch May 27, 2025 07:55

unitALG mentioned this pull request Sep 16, 2025

DOCS: Restored missing images from workflow manual pages (DOCATT-9570) #2236

Merged

1 task

unitALG added DOCATT_DocsQualityWeek and removed DOCATT_DocsQualityWeek labels Sep 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCS: Accessibility update to comply with our accessibility legal requirements. #2185

DOCS: Accessibility update to comply with our accessibility legal requirements. #2185

Uh oh!

Sam-Unity commented May 20, 2025

Uh oh!

unity-cla-assistant commented May 20, 2025 •

edited

Loading

Uh oh!

codecov-github-com bot commented May 20, 2025 •

edited

Loading

Uh oh!

jfreire-unity May 21, 2025

Uh oh!

Sam-Unity May 21, 2025

Uh oh!

jfreire-unity May 21, 2025

Uh oh!

Sam-Unity May 21, 2025 •

edited

Loading

Uh oh!

jfreire-unity left a comment

Uh oh!

ekcoh left a comment

Uh oh!

Pauliusd01 left a comment

Uh oh!

Pauliusd01 commented May 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants


		Once you have created and assigned project-wide actions, the Input System Package page in Project Settings displays the Actions Editor interface. Read more about how to use the [Actions Editor](ActionsEditor.md) to configure your actions.

		![image alt text](./Images/ProjectSettingsInputActionsSimpleShot.png)


		You can also delete all action maps, or reset all the actions back to the default values from the more (⋮) menu at the top right of the Input Actions section of the settings window, below the Project Settings window search field.

		![The Input Actions more menu as displayed in the Project Settings window](images/InputActionsSettingsMoreMenu.png)

DOCS: Accessibility update to comply with our accessibility legal requirements. #2185

DOCS: Accessibility update to comply with our accessibility legal requirements. #2185

Uh oh!

Conversation

Sam-Unity commented May 20, 2025

Description

Testing status & QA

Overall Product Risks

Comments to reviewers

Checklist

Uh oh!

unity-cla-assistant commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-github-com bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jfreire-unity May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Sam-Unity May 21, 2025

Choose a reason for hiding this comment

Uh oh!

jfreire-unity May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Sam-Unity May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jfreire-unity left a comment

Choose a reason for hiding this comment

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

Pauliusd01 left a comment

Choose a reason for hiding this comment

Uh oh!

Pauliusd01 commented May 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

unity-cla-assistant commented May 20, 2025 •

edited

Loading

codecov-github-com bot commented May 20, 2025 •

edited

Loading

Sam-Unity May 21, 2025 •

edited

Loading