Skip to content

DOCS: Fix typo's in using-direct-workflow.md (DOCATT-11243) - #2493

Closed
david-beep-one wants to merge 2 commits into
developfrom
docs/docatt-11243
Closed

david-beep-one wants to merge 2 commits into
developfrom
docs/docatt-11243

Conversation

@david-beep-one

@david-beep-one david-beep-one commented Oct 5, 2026 •

Copy link
Copy Markdown

Description

Addresses DOCATT-11243, a user-reported documentation feedback ticket and other typos found on the page.

  • The last sentence of the Direct workflow page contained an extra word, "For more a more flexible workflow."
  • "so you do not benefit from all the features come with "
  • "The example above reads values directly from the right trigger," - extra space

Testing status & QA

Documentation-only change, tested changes locally.

Overall Product Risks

  • Complexity: Low – documentation text change only.
  • Halo Effect: Low – no code changes; affects only the using-direct-workflow manual page.

Comments to reviewers

Docs Reviewer: Please check to see if changes meet the guidelines.
Jira Ticket: https://jira.unity3d.com/browse/DOCATT-11243

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.

@david-beep-one david-beep-one changed the title DOCS: Fix typo in using-direct-workflow.md (DOCATT-11243) DOCS: Fix typo's in using-direct-workflow.md (DOCATT-11243) Oct 5, 2026
@david-beep-one
david-beep-one marked this pull request as ready for review October 5, 2026 20:10

@u-pr u-pr Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Harness Review

Ship it

The three edits correct wording and spacing on the direct workflow page. I examined the surrounding example and links and found no actionable issues.

Reviewed commit 647afe2

🤖 Helpful? 👍/👎

@codecov-github-com

codecov-github-com Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff            @@
##           develop    #2493   +/-   ##
========================================
  Coverage    78.96%   78.96%           
========================================
  Files          767      767           
  Lines       140949   140949           
========================================
  Hits        111305   111305           
  Misses       29644    29644           
Flag Coverage Δ
inputsystem_Windows_6000.0 5.30% <ø> (ø)
inputsystem_Windows_6000.3 5.30% <ø> (ø)
inputsystem_Windows_6000.6 5.29% <ø> (ø)

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

ℹ️ Need help interpreting these results?

![The Input Device icon leads directly into the icon representing your action code.](Images/Workflow-Direct.png)

This is the simplest and most direct input workflow, but the least flexible. It bypasses the [Input Actions editor](actions-editor.md), so you do not benefit from all the features come with [Actions](actions.md).
This is the simplest and most direct input workflow, but the least flexible. It bypasses the [Input Actions editor](actions-editor.md), so you do not benefit from all the features that come with [Actions](actions.md).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This is the simplest and most direct input workflow, but the least flexible. It bypasses the [Input Actions editor](actions-editor.md), so you do not benefit from all the features that come with [Actions](actions.md).
This is the simplest and most direct input workflow but the least flexible. It bypasses the [Input Actions editor](actions-editor.md), so you don't benefit from all the features that come with [Actions](actions.md).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Your change is correct. I'm adding onto it because there are some other parts of this line that go against our style guide:

```

The example above reads values directly from the right trigger, and the left stick, of the currently connected [gamepad](devices-gamepads.md). It does not use the input system’s "Action" class, and instead the conceptual actions in your game or app, such as "move" and "use", are implicitly defined by what your code does in response to the input. You can use the same approach for other Device types such as the [keyboard](xref:UnityEngine.InputSystem.Keyboard) or [mouse](xref:UnityEngine.InputSystem.Mouse).
The example above reads values directly from the right trigger, and the left stick, of the currently connected [gamepad](devices-gamepads.md). It does not use the input system’s "Action" class, and instead the conceptual actions in your game or app, such as "move" and "use", are implicitly defined by what your code does in response to the input. You can use the same approach for other Device types such as the [keyboard](xref:UnityEngine.InputSystem.Keyboard) or [mouse](xref:UnityEngine.InputSystem.Mouse).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The example above reads values directly from the right trigger, and the left stick, of the currently connected [gamepad](devices-gamepads.md). It does not use the input system’s "Action" class, and instead the conceptual actions in your game or app, such as "move" and "use", are implicitly defined by what your code does in response to the input. You can use the same approach for other Device types such as the [keyboard](xref:UnityEngine.InputSystem.Keyboard) or [mouse](xref:UnityEngine.InputSystem.Mouse).
The example above reads values directly from the right trigger, and the left stick, of the connected [gamepad](devices-gamepads.md). It doesn't use the input system’s "Action" class. Instead, what the code does in response to the input implicitly defines the conceptual actions, such as "move" and "use" in the game or app. You can use the same approach for other Device types such as the [keyboard](xref:UnityEngine.InputSystem.Keyboard) or [mouse](xref:UnityEngine.InputSystem.Mouse).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Again, your change is good. I'm adding to it because other parts of the line go against our guidance:

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.

2 participants