FIX: Nothing to see here #2275
Draft
FIX: Nothing to see here #2275
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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
Removed <para> that seemed accidental causing package validation error.
- Removed GeneratePrecompiledLayout.png which was genuinely not referenced anywhere - The rest are all still actually being used in the docs, but likely were missed because they were sitting inside an HTML <img> tag instead of the usual Markdown structure, so I switched to use the Markdown structure.
- Switched back to '../api/UnityEngine.InputSystem.Switch.SwitchProControllerHID.html' from 'xref:UnityEngine.InputSystem.Switch.SwitchProControllerHID'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Please fill this section with a description what the pull request is trying to address and what changes were made.
Testing status & QA
Please describe the testing already done by you and what testing you request/recommend QA to execute. If you used or created any testing project please link them here too for QA.
Overall Product Risks
Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.
Comments to reviewers
Please describe any additional information such as what to focus on, or historical info for the reviewers.
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.After merge: