Skip to content

docs: 0.43.0 release prep and plain-language pass - #145

Merged
mescon merged 4 commits into
masterfrom
release/0.43.0-prep
Nov 9, 2026
Merged

mescon merged 4 commits into
masterfrom
release/0.43.0-prep

Conversation

@mescon

@mescon mescon commented Nov 6, 2026

Copy link
Copy Markdown
Owner

Release prep for 0.43.0, docs only.

  • CHANGELOG entry for 0.43.0 (RS H-Shifter support, hot-plug, the probe fold, pulldown-cmark, the USB enumeration troubleshooting entry).
  • CREDITS: kangaro0 ([Bug] Wheel not connecting properly #141) and the fenixadam captures ([Bug] Returning to Windows G923 Xbox Edition #134, GitHub suspension #135).
  • README: the H-Shifter in the feature table and the accessory section, a troubleshooting entry for a wheel that never enumerates.
  • A plain-language pass over the README and every page under docs: short sentences, active voice, one idea per sentence, technical terms explained on first use, instructions as ordered steps. Reference documents (protocol spec, sysfs reference, TrueForce notes) got the pass on prose only; tables, byte layouts and code blocks are unchanged.
  • Stale facts found on the way and corrected against the driver source: the effect loop runs at 1 kHz (not 500 Hz), LED effect modes 3 and 4 were swapped in the sysfs table, the Xbox range_restore default is on, the OLED feature row in the matrix, and the open-item list in STATUS.
  • docs/GAME_SETUP.md is regenerated from its generator; the three doc tests pass.

The matching wiki pass is pushed separately.

Short sentences, active voice, one idea per sentence, technical terms
explained on first use, instructions as ordered steps. Reference documents
(protocol spec, sysfs reference, TrueForce notes) keep every table, byte
layout and code block unchanged; only the prose moved.

Stale facts corrected against the driver source on the way: the effect
loop and the TrueForce packet cadence are 1 kHz (the docs still said 500
and 250 Hz in places), LED effect modes 3 and 4 were swapped in the sysfs
table, the G923 Xbox range_restore default is on, the OLED feature row in
the matrix, the rev-light write cadence, the G Hub software id, and the
open-item list in STATUS.

docs/GAME_SETUP.md is regenerated from its generator.
…lone handbrake)

Resolve the two doc hunks in favour of the hardware-verified facts from
#139: Reverse is button 20 (evdev 0x2c4) on the H-Shifter and on a DB9
shifter through the Racing Adapter, index 19 is not used, and
wheel_accessory lists every attached accessory in a fixed order.
Add the 0.43.0 changelog items for #139: the Racing Adapter on the base,
the standalone RS Shifter & Handbrake and adapter on the Test page, and
wheel_accessory listing every attached accessory (closes #144). Correct
the H-Shifter button range to 12 to 20 with Reverse on button 20 (evdev
0x2c4) in the README and changelog, add the adapter to the README matrix
and paragraph, and bring the FEATURE_MATRIX note and the two driver
comments above wheel_accessory in line with the three-accessory list.
Set the release date.
@sonarqubecloud

sonarqubecloud Bot commented Nov 9, 2026

Copy link
Copy Markdown

@mescon
mescon merged commit 5cfd292 into master Nov 9, 2026
23 checks passed
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.

1 participant