From 27ca00277c1e6c5962e9f6007411b8bd36a1446b Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 5 Sep 2026 10:33:27 -0400 Subject: [PATCH] docs: add docs navigation buttons This change adds previous/next navigation buttons across the main documentation pages so readers can move more easily between the overview, usage, platform, driver, and development guides. The updates are limited to documentation and improve cross-linking without changing runtime behavior. --- LICENSE.md | 2 +- LICENSES/{README.md => license-map.md} | 8 ++++++++ README.md | 10 +++++++++- docs/Doxyfile | 2 +- docs/development.md | 8 ++++++++ docs/end-user-gamepad-guide.md | 8 ++++++++ docs/platform-support.md | 8 ++++++++ docs/streaming-host-integration.md | 8 ++++++++ docs/todo.md | 9 ++++++--- docs/usage.md | 8 ++++++++ docs/windows-driver.md | 10 +++++++++- gh-pages-template/virtual-hid-driver.html | 2 +- 12 files changed, 75 insertions(+), 8 deletions(-) rename LICENSES/{README.md => license-map.md} (79%) diff --git a/LICENSE.md b/LICENSE.md index 4c3cf3b..aa31b75 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -10,5 +10,5 @@ summary and does not replace the complete license texts. sources, and generated Windows driver package artifacts are licensed under the [LizardByte Source-Available License 1.0](LICENSES/LicenseRef-LizardByte-SAL-1.0.md). -See the [license map](LICENSES/README.md) for the authoritative repository path +See the [license map](LICENSES/license-map.md) for the authoritative repository path and artifact assignments. diff --git a/LICENSES/README.md b/LICENSES/license-map.md similarity index 79% rename from LICENSES/README.md rename to LICENSES/license-map.md index 2e1d3e4..55ddae2 100644 --- a/LICENSES/README.md +++ b/LICENSES/license-map.md @@ -20,3 +20,11 @@ Every installed library distribution includes the MIT notice under `share/licenses/libvirtualhid`. The Windows driver MSI may include MIT-licensed helper components from this repository; packaged installs include both license texts for that reason. + +
+ +| Previous | Next | +|:--------------------------------------|-------------------------------------------------------------:| +| [Development](../docs/development.md) | [Source Code](../third-party/doxyconfig/docs/source_code.md) | + +
diff --git a/README.md b/README.md index 295d056..655a27d 100644 --- a/README.md +++ b/README.md @@ -189,5 +189,13 @@ licensed under the (LB-SAL 1.0). The root [license notice](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSE.md) points to both complete license texts; see the -[license map](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/README.md) +[license map](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/license-map.md) for the authoritative repository path and artifact assignments. + +
+ +| Previous | Next | +|:---------|---------------------------------------------------------:| +| | [End-User Gamepad Guide](docs/end-user-gamepad-guide.md) | + +
diff --git a/docs/Doxyfile b/docs/Doxyfile index a7b9dc2..fdf482a 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -44,7 +44,7 @@ INPUT = ../README.md \ todo.md \ streaming-host-integration.md \ development.md \ - ../LICENSES/README.md \ + ../LICENSES/license-map.md \ ../examples \ ../third-party/doxyconfig/docs/source_code.md \ ../src/include diff --git a/docs/development.md b/docs/development.md index b4ec5ce..c183d0e 100644 --- a/docs/development.md +++ b/docs/development.md @@ -96,3 +96,11 @@ code and tests provide a better source of truth. - Evaluate an optional FreeBSD CUSE-backed `uhid(4)`-compatible device for direct HID consumers. This would supplement uinput; it is not equivalent to registering a virtual device with FreeBSD's kernel HID bus. + +
+ +| Previous | Next | +|:------------------------------------------------------------|------------------------------------------:| +| [Streaming-Host Integration](streaming-host-integration.md) | [License Map](../LICENSES/license-map.md) | + +
diff --git a/docs/end-user-gamepad-guide.md b/docs/end-user-gamepad-guide.md index a37148b..5d82294 100644 --- a/docs/end-user-gamepad-guide.md +++ b/docs/end-user-gamepad-guide.md @@ -290,3 +290,11 @@ reaching the library but the virtual device reports it incorrectly. The [Moonlight setup guide](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide) links the official clients and their support resources. + +
+ +| Previous | Next | +|:-------------------------|--------------------------:| +| [Overview](../README.md) | [Usage and API](usage.md) | + +
diff --git a/docs/platform-support.md b/docs/platform-support.md index f3efa99..f496e75 100644 --- a/docs/platform-support.md +++ b/docs/platform-support.md @@ -437,3 +437,11 @@ Native macOS virtual-HID gamepad support is planned. A future backend may use `IOHIDUserDevice`, DriverKit/HIDDriverKit, or a combination that preserves the same public API while documenting any signing, entitlement, and installer requirements. + +
+ +| Previous | Next | +|:--------------------------|--------------------------------------------:| +| [Usage and API](usage.md) | [Windows Driver Package](windows-driver.md) | + +
diff --git a/docs/streaming-host-integration.md b/docs/streaming-host-integration.md index 872bae4..9df5e6d 100644 --- a/docs/streaming-host-integration.md +++ b/docs/streaming-host-integration.md @@ -63,3 +63,11 @@ The core API and adapter shape cover the major streaming-host requirements: - FreeBSD uinput gamepads and pointer devices, with basic PlayStation input and rumble but without Linux UHID-only PlayStation features. - Windows UMDF/VHF gamepad creation through an installed driver package. + +
+ +| Previous | Next | +|:----------------|------------------------------:| +| [TODO](todo.md) | [Development](development.md) | + +
diff --git a/docs/todo.md b/docs/todo.md index 3c62c0a..b85bfc5 100644 --- a/docs/todo.md +++ b/docs/todo.md @@ -35,7 +35,10 @@ Proposed solution: commit a generated capture later if it is reproducible, sanitized, and used by tests or documentation in a way that justifies keeping it. -## PlayStation and Nintendo Rumble +
-Status: native output-path validation and the remaining Steam and Chromium -consumer gaps are tracked in [GitHub issue #80](https://github.com/LizardByte/libvirtualhid/issues/80). +| Previous | Next | +|:--------------------------------------------|------------------------------------------------------------:| +| [Windows Driver Package](windows-driver.md) | [Streaming-Host Integration](streaming-host-integration.md) | + +
diff --git a/docs/usage.md b/docs/usage.md index d8a9ff4..9ee760a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -248,3 +248,11 @@ for every profile. The `misc1` button represents Share/Capture/Mic Mute-style controls and is available on the generic, Xbox Series, DualSense, and Switch Pro profiles; Xbox 360 and Xbox One do not advertise that extra button. + +
+ +| Previous | Next | +|:----------------------------------------------------|----------------------------------------:| +| [End-User Gamepad Guide](end-user-gamepad-guide.md) | [Platform Support](platform-support.md) | + +
diff --git a/docs/windows-driver.md b/docs/windows-driver.md index fd92d43..1808a3f 100644 --- a/docs/windows-driver.md +++ b/docs/windows-driver.md @@ -494,6 +494,14 @@ and must not ship the local pull-request test certificate. The Windows UMDF driver, broker, proprietary entitlement/evaluation sources, and generated Windows driver package artifacts, including the driver MSI, are licensed under the LizardByte Source-Available License 1.0 (LB-SAL 1.0). See -the [license map](../LICENSES/README.md) for the full repository license split. +the [license map](../LICENSES/license-map.md) for the full repository license split. The MSI may also include MIT-licensed helper components from this repository, so packaged installs include both license texts. + +
+ +| Previous | Next | +|:----------------------------------------|----------------:| +| [Platform Support](platform-support.md) | [TODO](todo.md) | + +
diff --git a/gh-pages-template/virtual-hid-driver.html b/gh-pages-template/virtual-hid-driver.html index 91d1e65..179d9c4 100644 --- a/gh-pages-template/virtual-hid-driver.html +++ b/gh-pages-template/virtual-hid-driver.html @@ -138,7 +138,7 @@

License

- + View license map