Skip to content

Updated the Devices section#2121

Merged
jo-unity merged 15 commits into
docs-content-model-reorgfrom
docs/devices-reorg-DOCF-6409
Feb 7, 2025
Merged

Updated the Devices section#2121
jo-unity merged 15 commits into
docs-content-model-reorgfrom
docs/devices-reorg-DOCF-6409

Conversation

@jo-unity
Copy link
Copy Markdown
Collaborator

I updated the Devices section of the user manual. Pages I was most concerned with:

* [Devices](devices.md)
  * [Types of input devices](devices-overview.md)
  * [Pointer devices](devices-pointers.md)
      * [Pointer devices introduction](pointers-introduction.md)
      * [Touch devices](devices-touch.md)
        * [Touch devices introduction](touch-introduction.md)
        * [Polling touch input](touch-polling.md)
        * [Simulate touch input](simulate-touch-input.md)
        * [Bind touch input to an action](bind-touch-input.md)
      * [Mouse devices](devices-mouse.md)
        * [Mouse devices introduction](mouse-introduction.md)
        * [Query and control mouse devices in code](query-mouse-devices.md)
      * [Pen devices](devices-pen.md)
        * [Pen devices introduction](pen-introduction.md)
        * [Query pen devices in code](query-pen-devices.md)
  * [Keyboards](devices-keyboard.md)
    * [Keyboards introduction](keyboards-introduction.md)
    * [Query keyboards in code](query-keyboards.md)
    * [Read text input](read-keyboard-text-input.md)
  * [Joysticks](devices-joysticks.md)
  * [Gamepads](devices-gamepads.md)
    * [Gamepads introduction](gamepads-introduction.md)
    * [PlayStation gamepads](gamepads-playstation.md)
    * [Switch gamepads](gamepads-switch.md)
    * [Xbox gamepads](gamepads-xbox.md)
    * [Query and control gamepads in code](query-gamepads.md)
    * [Polling gamepad input](gamepad-polling.md)
    * [Gamepad haptics](gamepad-haptics.md)
  * [Sensors](devices-sensors.md)
    * [Sensors introduction](sensors-introduction.md)
    * [Query sensors in code](query-sensors.md)
    * [Supported sensors reference](supported-sensors-reference.md)
  * [Human Interface Device specification](hid-specification.md)
    * [Human Interface Device specification introduction](hid-specification-introduction.md)
    * [Create a custom device layout](hid-create-custom-layout.md)
    * [Use an existing input device to create a layout](hid-create-custom-layout-existing.md)
    * [Use a custom class to create a layout](hid-create-custom-layout-class.md)
  * [Supported devices reference](supported-devices-reference.md)

NOTE: The "Supported Devices Reference" page needs validation from devs. Much of the information might be wrong. General feedback on the layout is appreciated, but the details of the content are likely to change in a future PR.

@unity-cla-assistant
Copy link
Copy Markdown

unity-cla-assistant commented Jan 30, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown

@siobhan-unity siobhan-unity left a comment

Choose a reason for hiding this comment

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

I think the structure looks great, the pages have clear goals and types.

I would suggest another look at the descriptions for pages that appear on landing pages, as the content model recommends that they always begin with verbs (even for concept and reference pages), and there are a few landing pages that don't follow this advice.

Everything else looks all good to me!

Comment thread Packages/com.unity.inputsystem/Documentation~/pointers-introduction.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/devices-touch.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/devices-mouse.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/devices-mouse.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/devices-pen.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/query-sensors.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/devices.md Outdated
jo-unity and others added 2 commits February 4, 2025 11:16
Co-authored-by: Siobhan Fitzgerald-Gibson <52451117+siobhan-unity@users.noreply.github.com>
Comment thread Packages/com.unity.inputsystem/Documentation~/mouse-introduction.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/read-keyboard-text-input.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/simulate-touch-input.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/touch-introduction.md Outdated
Co-authored-by: Ben Pitt <benp@unity3d.com>
Comment thread Packages/com.unity.inputsystem/Documentation~/mouse-introduction.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/pen-introduction.md Outdated
@jo-unity jo-unity requested a review from duckets February 7, 2025 11:04
Comment thread Packages/com.unity.inputsystem/Documentation~/keyboards-introduction.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/mouse-introduction.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/pen-introduction.md Outdated
@jo-unity jo-unity merged commit b20cb98 into docs-content-model-reorg Feb 7, 2025
@jo-unity jo-unity deleted the docs/devices-reorg-DOCF-6409 branch February 7, 2025 13:27
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.

4 participants