-
Notifications
You must be signed in to change notification settings - Fork 329
DOCS: Documentation edits for clarity, usability, and conformation to doc standards #2253
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
unitALG
wants to merge
14
commits into
develop
Choose a base branch
from
docatt-substantial-doc-edits
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
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
Based on the following feedback tickets, I edited some of the pages in the manual:
<layoutName>{usageName}controlName#(displayName)
was the composition of the path, while the InputControlPath class said it was<Layout>{Usage}#(DisplayName)Name
).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:
Testing status & QA
Overall Product Risks
Low risk, since no code was modified.
Comments to reviewers
Checklist
DOCS:
.