Skip to content

Conversation

unitALG
Copy link
Contributor

@unitALG unitALG commented Oct 6, 2025

Description

Based on the following feedback tickets, I edited some of the pages in the manual:

  • DOCATT-8537: Clarified the installation requirements, including adhering to doc standards more (with step-based procedure and adjusted titles).
  • DOCATT-8578: Merged duplicated information on Control paths between the API docs and the manual. Whenever there was a discrepancy, I used the guidance from the API docs (for example, the manual said that <layoutName>{usageName}controlName#(displayName) was the composition of the path, while the InputControlPath class said it was <Layout>{Usage}#(DisplayName)Name).
  • DOCATT-8743: Edited several MD files connected to the concepts for bindings, input, and controls, including merging some of the manual & API documentation for InputControl & PlayerInput classes and fixing some links to nonexistent anchors.
  • DOCATT-9373: Removed the incomplete sentence from the InputActionPhase.Canceled enum value doc.

In addition to those content changes, I also performed a number of changes across several pages that were either structural or more global fixes, which I made in separate commits for clarity:

  • Added missing UIDs to manual pages: this was in preparation to convert all links using relative paths to use xref/uid values.
  • Normalized "NOTE" and "IMPORTANT" admonitions throughout docs because they were extremely inconsistent in terms of styling and presentation, and most of them didn't use the built-in DocFx support for admonitions.
  • Applied standards for images, including more consistent sizing and web accessibility-compliant alt text. Also removed unnecessary screen shots of the Editor where possible (to avoid version-specific inconsistencies).
  • Removed mini-TOCS that appeared on some (but not all) manual pages. These weren't compliant with the documentation standards and weren't automated, so some were missing sections that had been added later. And DocFx already generates mini-TOCs for the sidebar, so they were redundant.
  • Replaced all links using relative paths with xrefs. These were links to pages in the manual and API docs inside the package as well as links to the Engine docs.

Testing status & QA

  • Generated the documentation locally.

Overall Product Risks

Low risk, since no code was modified.

Comments to reviewers

  • Some of the changes I made affected most or all manual pages, such as replacing relative links with xref-based links, but I made sure to use a separate commit to make it easier to see the changes that were content-only.
  • Any time I made changes to headings I updated any links referring to those headings.

Checklist

  • No changelog entry added..
  • Commit message for squash-merge is prefixed with DOCS: .
  • No forward/backward port needed.

- Content was not modified: this was only to make everything consistent and leverage the extended Markdown feature
# Conflicts:
#	Packages/com.unity.inputsystem/Documentation~/PlayerInput.md
- Applied consistent sizing for most component windows
- Updated the alt text to comply with accessibility standards (not an exhaustive search; just the ones I happened to find)
- Removed some images that were redundant or purely screen shots describing the UI elements that appear in the Editor (future-proofing)
- Also replaced "see <reference>" with "refer to <>" in compliance with style guide guidance
- Similar data but somewhat conflicting information on structure & syntax for InputControl paths
- Merged the information from API to Manual topic on the subject, preferring the API information when it diverged
- Also restructured the table a little to include links to related APIs and manual topics instead of examples
- Removed only the control path information from the InputControlPath class and left a link to the manual topic behind
- Updated the installation instructions to use steps and make it standard compliant
- Also changed the titles to be doc standard compliant (and updated external links pointing there)
- These weren't doc standard compliant and weren't automated (some were missing added sections)
- The sidebar TOCs are already automatically generated by DocFx
- Similar to DOCATT-8578, I merged some of the manual & API documentation for InputControl & PlayerInput classes as part of edits
- Also corrected some links to anchors that didn't exist in Sensors.md, HID.md, and Testing.md
# Conflicts:
#	Packages/com.unity.inputsystem/Documentation~/ActionBindings.md
@codecov-github-com
Copy link

codecov-github-com bot commented Oct 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff            @@
##           develop    #2253   +/-   ##
========================================
  Coverage    76.70%   76.71%           
========================================
  Files          465      465           
  Lines        87919    87919           
========================================
+ Hits         67442    67445    +3     
+ Misses       20477    20474    -3     
Flag Coverage Δ
inputsystem_MacOS_2021.3_project 78.06% <ø> (+<0.01%) ⬆️
inputsystem_MacOS_2022.3_project 74.59% <ø> (+<0.01%) ⬆️
inputsystem_MacOS_6000.0_project 76.51% <ø> (+<0.01%) ⬆️
inputsystem_MacOS_6000.2_project 76.51% <ø> (+<0.01%) ⬆️
inputsystem_MacOS_6000.3_project 76.51% <ø> (+<0.01%) ⬆️
inputsystem_MacOS_6000.4_project 76.52% <ø> (+0.01%) ⬆️
inputsystem_Ubuntu_2021.3_project 77.96% <ø> (ø)
inputsystem_Ubuntu_2022.3_project 74.39% <ø> (ø)
inputsystem_Ubuntu_6000.0_project 76.32% <ø> (ø)
inputsystem_Ubuntu_6000.2_project 76.32% <ø> (ø)
inputsystem_Ubuntu_6000.3_project 76.31% <ø> (ø)
inputsystem_Ubuntu_6000.4_project 76.31% <ø> (-0.01%) ⬇️
inputsystem_Windows_2021.3_project 78.20% <ø> (+<0.01%) ⬆️
inputsystem_Windows_2022.3_project 74.73% <ø> (+<0.01%) ⬆️
inputsystem_Windows_6000.0_project 76.65% <ø> (+<0.01%) ⬆️
inputsystem_Windows_6000.2_project 76.65% <ø> (+<0.01%) ⬆️
inputsystem_Windows_6000.3_project 76.65% <ø> (+<0.01%) ⬆️
inputsystem_Windows_6000.4_project 76.65% <ø> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...ity.inputsystem/InputSystem/Actions/InputAction.cs 92.34% <ø> (ø)
....inputsystem/InputSystem/Actions/InputActionMap.cs 93.22% <ø> (ø)
...nputsystem/InputSystem/Actions/InputActionTrace.cs 79.56% <ø> (ø)
...y.inputsystem/InputSystem/Controls/InputControl.cs 79.86% <ø> (ø)
...stem/InputSystem/Controls/InputControlAttribute.cs 100.00% <ø> (ø)
...putsystem/InputSystem/Controls/InputControlPath.cs 87.91% <ø> (ø)
...ity.inputsystem/InputSystem/Controls/KeyControl.cs 73.07% <ø> (ø)
....unity.inputsystem/InputSystem/Devices/Keyboard.cs 95.60% <ø> (ø)
...com.unity.inputsystem/InputSystem/Devices/Mouse.cs 100.00% <ø> (ø)
...om.unity.inputsystem/InputSystem/Devices/Sensor.cs 99.53% <ø> (ø)
... and 5 more

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@unitALG unitALG requested review from LeoUnity and jfreire-unity and removed request for LeoUnity October 6, 2025 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant