continued content model reorg WIP

duckets · duckets · commit 1138f2aa9d91 · 2024-11-15T18:30:08.000Z
diff --git a/Packages/com.unity.inputsystem/Documentation~/Actions.md b/Packages/com.unity.inputsystem/Documentation~/Actions.md
@@ -21,5 +21,5 @@ Actions also make it simpler to create a system that lets your players [customiz
 >**Notes:**
 > - Actions are a runtime only feature. You can't use them in [Editor window code](https://docs.unity3d.com/ScriptReference/EditorWindow.html).
 >
-> - You can read input without using Actions and Bindings by directly reading specific device controls. This is less flexible, but can be quicker to implement for certain situations. Read more about [directly reading devices from script](Workflow-Direct.md).
+> - You can read input without using Actions and Bindings by directly reading specific device controls. This is less flexible, but can be quicker to implement for certain situations. Read more about [directly reading devices from script](using-direct-workflow.md).
 >
diff --git a/Packages/com.unity.inputsystem/Documentation~/HowDoI.md b/Packages/com.unity.inputsystem/Documentation~/HowDoI.md
@@ -7,7 +7,7 @@ A collection of frequently asked questions, and where to find their answers in t
 
 > **Note:**
 >
-> If you're new to the Input System and have landed on this page looking for documentation, it's best to read the [QuickStart Guide](QuickStartGuide.md), and the [Concepts](Concepts.md) and [Workflows](Workflows.md) pages, so that you can make sure you're choosing the best workflow for your project's input requirements.
+> If you're new to the Input System and have landed on this page looking for documentation, it's best to read the [QuickStart Guide](quick-start-guide.md), and the [Concepts](understanding-input.md) and [Workflows](workflows.md) pages, so that you can make sure you're choosing the best workflow for your project's input requirements.
 >
 > This is because there are a number of different ways to read input using the Input System, and many of the answers on this page give you the quickest but least flexible solution, and may not be suitable for a project with more complex requirements.
 
@@ -27,7 +27,7 @@ How do I...?
 - [create my own custom devices?](HID.md#creating-a-custom-device-layout)
 
 - create a simple "Fire" type action?</br>
-Use the same techniques shown for the "Jump" action in the [Workflows section](Workflows.md)
+Use the same techniques shown for the "Jump" action in the [Workflows section](workflows.md)
 
 - [require a button to be held down for some duration before triggering an action?](Interactions.html#hold)
 
diff --git a/Packages/com.unity.inputsystem/Documentation~/Migration.md b/Packages/com.unity.inputsystem/Documentation~/Migration.md
@@ -17,7 +17,7 @@ This page is provided to help you match input-related API from Unity's old, buil
 
 ## Read the introductory documentation first
 
-If you're new to the Input System package and have landed on this page looking for documentation, it's best to read the [QuickStart Guide](QuickStartGuide.md), and the [Concepts](Concepts.md) and [Workflows](Workflows.md) pages from the introduction section of the documentation, so that you can make sure you're choosing the best workflow for your project's input requirements.
+If you're new to the Input System package and have landed on this page looking for documentation, it's best to read the [QuickStart Guide](quick-start-guide.md), and the [Concepts](understanding-input.md) and [Workflows](workflows.md) pages from the introduction section of the documentation, so that you can make sure you're choosing the best workflow for your project's input requirements.
 
 This is because there are a number of different ways to read input using the Input System, and some of the directly corresponding API methods on this page might give you the quickest - but least flexible - solution, and may not be suitable for a project with more complex requirements.
 
@@ -78,7 +78,7 @@ Then, to read the action values, use the following:
 
 ### Directly reading Gamepad and Joystick controls
 
-Directly reading hardware controls bypasses the new Input System's action-based workflow, which has some benefits and some drawbacks. ([Read more about directly reading devices](./Workflow-Direct.md))
+Directly reading hardware controls bypasses the new Input System's action-based workflow, which has some benefits and some drawbacks. ([Read more about directly reading devices](./using-direct-workflow.md))
 
 
 |Input Manager (Old)|Input System (New)|
diff --git a/Packages/com.unity.inputsystem/Documentation~/TableOfContents.md b/Packages/com.unity.inputsystem/Documentation~/TableOfContents.md
@@ -1,12 +1,12 @@
 
 * [Introduction](index.md)
   * [Installation](Installation.md)
-  * [Quickstart Guide](QuickStartGuide.md)
-  * [Concepts](Concepts.md)
-  * [Workflows](Workflows.md)
+  * [Quickstart Guide](quick-start-guide.md)
+  * [Concepts](understanding-input.md)
+  * [Workflows](workflows.md)
     * [Workflow - Actions](Workflow-Actions.md)
-    * [Workflow - Actions & PlayerInput](Workflow-PlayerInput.md)
-    * [Workflow - Direct](Workflow-Direct.md)
+    * [Workflow - Actions & PlayerInput](using-playerinput-workflow.md)
+    * [Workflow - Direct](using-direct-workflow.md)
 * [Setting up input](setting-up-input.md)
   * [Actions](actions.md)
   * [Action Assets](action-assets.md)
diff --git a/Packages/com.unity.inputsystem/Documentation~/action-assets.md b/Packages/com.unity.inputsystem/Documentation~/action-assets.md
diff --git a/Packages/com.unity.inputsystem/Documentation~/action-maps-panel.md b/Packages/com.unity.inputsystem/Documentation~/action-maps-panel.md
@@ -0,0 +1,2 @@
+# The action maps panel
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/action-properties-panel.md b/Packages/com.unity.inputsystem/Documentation~/action-properties-panel.md
@@ -0,0 +1 @@
+# Action properties panel
diff --git a/Packages/com.unity.inputsystem/Documentation~/actions-panel.md b/Packages/com.unity.inputsystem/Documentation~/actions-panel.md
@@ -0,0 +1 @@
+# Actions panel
diff --git a/Packages/com.unity.inputsystem/Documentation~/add-duplicate-delete-binding.md b/Packages/com.unity.inputsystem/Documentation~/add-duplicate-delete-binding.md
@@ -0,0 +1 @@
+# Add, duplicate or delete a binding
diff --git a/Packages/com.unity.inputsystem/Documentation~/binding-overrides.md b/Packages/com.unity.inputsystem/Documentation~/binding-overrides.md
@@ -0,0 +1 @@
+# Binding overrides
diff --git a/Packages/com.unity.inputsystem/Documentation~/binding-properties-panel.md b/Packages/com.unity.inputsystem/Documentation~/binding-properties-panel.md
@@ -0,0 +1,2 @@
+# Binding properties panel
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-action-properties.md b/Packages/com.unity.inputsystem/Documentation~/configure-action-properties.md
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-action-type.md b/Packages/com.unity.inputsystem/Documentation~/configure-action-type.md
@@ -0,0 +1,2 @@
+# Configure Action Type
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-actions.md b/Packages/com.unity.inputsystem/Documentation~/configure-actions.md
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-bindings-from-code.md b/Packages/com.unity.inputsystem/Documentation~/configure-bindings-from-code.md
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-control-type.md b/Packages/com.unity.inputsystem/Documentation~/configure-control-type.md
@@ -0,0 +1 @@
+# Configure Control Type
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-controls-from-code.md b/Packages/com.unity.inputsystem/Documentation~/configure-controls-from-code.md
@@ -0,0 +1,2 @@
+# Configure controls from code
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-input-directly-from-code.md b/Packages/com.unity.inputsystem/Documentation~/configure-input-directly-from-code.md
@@ -0,0 +1 @@
+# Configure input directly from code
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-input-from-code.md b/Packages/com.unity.inputsystem/Documentation~/configure-input-from-code.md
@@ -0,0 +1,2 @@
+# Configure input from code
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/configure-input-from-json.md b/Packages/com.unity.inputsystem/Documentation~/configure-input-from-json.md
@@ -0,0 +1,2 @@
+# Configure input from JSON
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/declare-standalone-actions.md b/Packages/com.unity.inputsystem/Documentation~/declare-standalone-actions.md
@@ -0,0 +1,2 @@
+# Declare stand-alone actions
+
diff --git a/Packages/com.unity.inputsystem/Documentation~/generate-cs-api-from-actions.md b/Packages/com.unity.inputsystem/Documentation~/generate-cs-api-from-actions.md
diff --git a/Packages/com.unity.inputsystem/Documentation~/index.md b/Packages/com.unity.inputsystem/Documentation~/index.md
@@ -15,7 +15,7 @@ This **Input System package** is a newer, more flexible system, which allows you
 
 During the installation process for the Input System package, the installer offers to automatically deactivate the older built-in system. ([Read more](Installation.md))
 
-To get started, see the [Installation](Installation.md) and [Workflows](Workflows.md) sections. For a demo project, see the [Warriors demo](https://github.com/UnityTechnologies/InputSystem_Warriors) on GitHub.
+To get started, see the [Installation](Installation.md) and [Workflows](workflows.md) sections. For a demo project, see the [Warriors demo](https://github.com/UnityTechnologies/InputSystem_Warriors) on GitHub.
 
 ![](Images/ActionsEditor.png)<br/>
 _The Input Actions Editor, displaying some of the default actions that come pre-configured with the Input System package._
diff --git a/Packages/com.unity.inputsystem/Documentation~/pick-control-binding.md b/Packages/com.unity.inputsystem/Documentation~/pick-control-binding.md
@@ -0,0 +1 @@
+# Pick a control for a binding
diff --git a/Packages/com.unity.inputsystem/Documentation~/quick-start-guide.md b/Packages/com.unity.inputsystem/Documentation~/quick-start-guide.md
@@ -1,7 +1,7 @@
 
 # Quickstart Guide
 
-This page has a brief description of how to quickly start using the Input System. The Input System has [multiple workflows](Workflows.md) which you might prefer that offer different benefits. This quickstart guide shows a workflow which suits most common scenarios.
+This page has a brief description of how to quickly start using the Input System. The Input System has [multiple workflows](workflows.md) which you might prefer that offer different benefits. This quickstart guide shows a workflow which suits most common scenarios.
 
 First, install the Input System package. For information on how to install the new Input System, see [Installation](Installation.md).
 
diff --git a/Packages/com.unity.inputsystem/Documentation~/set-binding-parameters.md b/Packages/com.unity.inputsystem/Documentation~/set-binding-parameters.md
@@ -0,0 +1 @@
+# Set binding parameters
diff --git a/Packages/com.unity.inputsystem/Documentation~/set-callbacks-on-actions.md b/Packages/com.unity.inputsystem/Documentation~/set-callbacks-on-actions.md
@@ -5,15 +5,15 @@ When you set up callbacks for your Action, the Action informs your code that a c
 
 There are several ways to do this:
 
-1. You can use the [PlayerInput component](Workflow-PlayerInput.md) to set up callbacks in the inspector.
+1. You can use the [PlayerInput component](using-playerinput-workflow.md) to set up callbacks in the inspector.
 1. Each Action has a [`started`, `performed`, and `canceled` callback](#action-callbacks).
 1. Each Action Map has an [`actionTriggered` callback](#inputactionmapactiontriggered-callback).
 1. The Input System has a global [`InputSystem.onActionChange` callback](#inputsystemonactionchange-callback).
 2. [`InputActionTrace`](#inputactiontrace) can record changes happening on Actions.
 
 #### The PlayerInput component
 
-The PlayerInput component is the simplest way to set up Action callbacks. It provides an interface in the inspector that allows you set up callbacks directly to your methods without requiring intermediate code. [Read more about the PlayerInput component](Workflow-PlayerInput.md).
+The PlayerInput component is the simplest way to set up Action callbacks. It provides an interface in the inspector that allows you set up callbacks directly to your methods without requiring intermediate code. [Read more about the PlayerInput component](using-playerinput-workflow.md).
 
 Alternatively, you can implement callbacks entirely from your own code using the following workflow:
 
diff --git a/Packages/com.unity.inputsystem/Documentation~/understanding-input.md b/Packages/com.unity.inputsystem/Documentation~/understanding-input.md
@@ -1,7 +1,9 @@
 ---
-uid: basic-concepts
+uid: understanding-input
 ---
-# Basic Concepts
+# Understanding input
+
+Input refers to signals sent by users of your game or app from an input device, such as a keyboard, mouse, touchscreen, gamepad, or joystick. Almost all Unity projects require input of some form, and the Input system package provides a flexible set of features which allow you to configure and respond to input in a way that suits your project.
 
 This page introduces the basic concepts that relate to working with the Input System. They relate to the steps in the sequence of events that occur when a user sends input to your game or app. The Input System provides features which implement these steps, or you can choose to implement some of them yourself.
 
diff --git a/Packages/com.unity.inputsystem/Documentation~/using-actions-workflow.md b/Packages/com.unity.inputsystem/Documentation~/using-actions-workflow.md
@@ -105,4 +105,4 @@ This is the recommended workflow with the Input System Package, providing a flex
 
 You benefit from the Action-based features such as Action Maps, Bindings, and the ability to configure them in the Actions Editor. You can also implement [user rebinding at run time](ActionBindings.html#interactive-rebinding).
 
-This workflow alone doesn't provide built-in support for local multiplayer scenarios with multiple devices, so if you are producing a local multiplayer game you might want to consider using the [Actions & PlayerInput](./Workflow-PlayerInput.md) workflow.
+This workflow alone doesn't provide built-in support for local multiplayer scenarios with multiple devices, so if you are producing a local multiplayer game you might want to consider using the [Actions & PlayerInput](./using-playerinput-workflow.md) workflow.
diff --git a/Packages/com.unity.inputsystem/Documentation~/using-direct-workflow.md b/Packages/com.unity.inputsystem/Documentation~/using-direct-workflow.md
diff --git a/Packages/com.unity.inputsystem/Documentation~/using-playerinput-workflow.md b/Packages/com.unity.inputsystem/Documentation~/using-playerinput-workflow.md

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,5 @@ Actions also make it simpler to create a system that lets your players [customiz`
`21`	`21`	`>Notes:`
`22`	`22`	`> - Actions are a runtime only feature. You can't use them in [Editor window code](https://docs.unity3d.com/ScriptReference/EditorWindow.html).`
`23`	`23`	`>`
`24`		`-> - You can read input without using Actions and Bindings by directly reading specific device controls. This is less flexible, but can be quicker to implement for certain situations. Read more about [directly reading devices from script](Workflow-Direct.md).`
	`24`	`+> - You can read input without using Actions and Bindings by directly reading specific device controls. This is less flexible, but can be quicker to implement for certain situations. Read more about [directly reading devices from script](using-direct-workflow.md).`
`25`	`25`	`>`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ A collection of frequently asked questions, and where to find their answers in t`
`7`	`7`
`8`	`8`	`> Note:`
`9`	`9`	`>`
`10`		`-> If you're new to the Input System and have landed on this page looking for documentation, it's best to read the [QuickStart Guide](QuickStartGuide.md), and the [Concepts](Concepts.md) and [Workflows](Workflows.md) pages, so that you can make sure you're choosing the best workflow for your project's input requirements.`
	`10`	`+> If you're new to the Input System and have landed on this page looking for documentation, it's best to read the [QuickStart Guide](quick-start-guide.md), and the [Concepts](understanding-input.md) and [Workflows](workflows.md) pages, so that you can make sure you're choosing the best workflow for your project's input requirements.`
`11`	`11`	`>`
`12`	`12`	`> This is because there are a number of different ways to read input using the Input System, and many of the answers on this page give you the quickest but least flexible solution, and may not be suitable for a project with more complex requirements.`
`13`	`13`
`@@ -27,7 +27,7 @@ How do I...?`
`27`	`27`	`- [create my own custom devices?](HID.md#creating-a-custom-device-layout)`
`28`	`28`
`29`	`29`	`- create a simple "Fire" type action?</br>`
`30`		`-Use the same techniques shown for the "Jump" action in the [Workflows section](Workflows.md)`
	`30`	`+Use the same techniques shown for the "Jump" action in the [Workflows section](workflows.md)`
`31`	`31`
`32`	`32`	`- [require a button to be held down for some duration before triggering an action?](Interactions.html#hold)`
`33`	`33`