diff options
| author | Jack Sangdahl <jack@pngu.org> | 2025-08-10 00:27:13 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-08-10 00:27:13 +0200 |
| commit | 00ca3628267ae85d3eb2ec19a364913c1fca434d (patch) | |
| tree | e95c1bfc3f809c6f036756924a29b8300b423bc0 /docs/ChangeLog | |
| parent | 9dcf2a11b252d95ad83f9cd34815c57c3147168d (diff) | |
Migrate `helix` common configuration (#25433)
* Initial tidying up of top level helix/ directory
Align readme.md with template & provide more detailed PCB information
Remove unused rules.mk
Add common config.h file
Update glcdfont.c with formatting and license header
* Further migrations after PRs merged
Move shared configuration to top level info.json and config.h
More descriptive hardware compatibility
* Add changelog
* Align configuration between PCBs
- Migrate beta & pico to use RGB Matrix
- Move previously RGB Matrix-dependent OLED code in rev3/rev3.c to top level
- Remove reundant OLED code in beta/beta.c
- Remove RGBLight references
* Update changelog with RGB Matrix configuration
Diffstat (limited to 'docs/ChangeLog')
| -rw-r--r-- | docs/ChangeLog/20250831/HelixRefactor.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/ChangeLog/20250831/HelixRefactor.md b/docs/ChangeLog/20250831/HelixRefactor.md new file mode 100644 index 0000000000..58136ce06b --- /dev/null +++ b/docs/ChangeLog/20250831/HelixRefactor.md | |||
| @@ -0,0 +1,37 @@ | |||
| 1 | # Refactor of `keyboards/helix` | ||
| 2 | |||
| 3 | This series of PRs aims to align this keyboard's configuration with current standards, and also remove unnecessary contents. | ||
| 4 | |||
| 5 | ### Refactor `helix/pico` [#25428](https://github.com/qmk/qmk_firmware/pull/25428) | ||
| 6 | - Removes redundant `back`, `base`, `sc`, `under`, & `qmk_conf` revisions | ||
| 7 | - Migrates legacy defines and configuration to JSON | ||
| 8 | - Migrates `default` keymap to JSON | ||
| 9 | - Fixes RGB configuration to illuminate 25 LEDs per half | ||
| 10 | - Enables standard features like Bootmagic, extrakey, etc. | ||
| 11 | - Updates keyboard aliases accordingly | ||
| 12 | |||
| 13 | ### Refactor `helix/rev2` [#25429](https://github.com/qmk/qmk_firmware/pull/25429) | ||
| 14 | - Removes redundant `back`, `base`, `sc`, `under`, & `qmk_conf` revisions | ||
| 15 | - Renames `rev2` to `beta`, as the only PCB sources in the official Helix GitHub repository are named "[beta](https://github.com/MakotoKurauchi/helix/tree/master/PCB/beta)", this keyboard's name in QMK Firmware was already "beta", and this PCB is sold under the name "[beta](https://shop.yushakobo.jp/products/oss_pcb?variant=39452554231969)" on the Yushakobo store | ||
| 16 | - Migrates legacy defines and configuration to JSON | ||
| 17 | - Migrates `default` keymap to JSON | ||
| 18 | - Fixes RGB configuration to illuminate 32 LEDs per half | ||
| 19 | - Enables standard features like Bootmagic, extrakey, etc. | ||
| 20 | - Updates keyboard aliases accordingly | ||
| 21 | - Tidy's up OLED code | ||
| 22 | - Adds alternate 4 row layout, as this PCB allows users to snap off the bottom row | ||
| 23 | |||
| 24 | ### Refactor `helix/rev3_{4,5}rows` [#25430](https://github.com/qmk/qmk_firmware/pull/25430) | ||
| 25 | - The `rev3_4rows` and `rev3_5rows` firmwares are identical, except for the extra row users can snap off. The 4 row PCB is not sold anywhere as an individual product, only the [5 row PCB](https://shop.yushakobo.jp/products/2143). Thus, this PR removes the aforementioned two build targets and adds a single `rev3` revision | ||
| 26 | - Migrates legacy defines and configuration to JSON | ||
| 27 | - Migrates `default` keymap to JSON | ||
| 28 | - Removes RGB Light configuration | ||
| 29 | - Updates keyboard aliases accordingly | ||
| 30 | - Tidy's up OLED code | ||
| 31 | - Adds alternate 4 row layout, as this PCB allows users to snap off the bottom row | ||
| 32 | |||
| 33 | ### Migrate helix common configuration [#25433](https://github.com/qmk/qmk_firmware/pull/25433) | ||
| 34 | - Migrates common configuration shared between revisions to the top-level keyboard directory | ||
| 35 | - Improves `readme.md` to provide more detail regarding PCB revisions | ||
| 36 | - Removes unnecessary top-level `rules.mk` file and other general tidying | ||
| 37 | - Migrates `beta` and `pico` revisions to use RGB Matrix, which is more appropriate as these PCBs are fit with per-key RGB LEDs | ||
