Description
With the release of https://zmkfirmware.dev/docs/codes/, it's time to explore operating system support!
For those unaware, it became clear during the codes redevelopment (#21) that documentation for HID operating system support was sometimes sparse or dated. So, we decided to include every feasible code we could identify so that the ZMK community could test them out and feedback their findings.
Objectives
Primary: turn any ❔ into ⭐ or ❌.
Secondary: collate together any useful information about each code, such as the everyday applications/conditions that do/don't support them. This information will probably go into footnotes or documented metadata for each code (TBD).
What should I do?
Please use this issue for discussing and recording your findings around the iOS operating system! Please don't keep this information in Discord as it will get lost over time, and some people don't even use it.
Please also check the open PRs first because someone may have already done the legwork but is awaiting verification:
https://github.com/zmkfirmware/zmk/pulls
Once you've tested a code, you can submit a PR by editing: docs/src/data/hid.js
Note for developers: if you're looking to automate (script) testing/verification across a large number of codes, that would be amazing. Please contact me on Discord (#development) first though as I can likely accelerate your efforts and work with you to minimize much of the PR red tape. Your efforts may also help accelerate the development of future end-2-end test systems for ZMK.
PR Guidelines
- PR title:
docs(codes): iOS Support: brief-description-of-codesbrief-description-of-codesshould briefly summarize the codes in the PR.
- PR description (template):
### iOS version/build?
### What codes did you test?
### How did you test?
### Have you any useful information?
### Has anyone else tested/verified it?
- We'll close (merge) PRs once it's clear that at least two people have verified each code, as we want to avoid false positives/negatives!
- If nobody else has tested your chosen codes yet, please submit a PR anyway. We'll keep it open until someone else verifies it.
- Please keep each PR atomic and limited in scope.
- Please don't bundle it with other unrelated changes (i.e. a bug fix or other enhancement)
- because it makes review and traceability later more difficult. If you do this, we'll ask you to resubmit two distinct PRs.
- Please don't submit lots of codes at once!
- The more changes you submit at once, the more difficult it is to review, verify and sign off the PR. Smaller PRs are better. We don't expect every code to be PR-ed individually however.
- Please aim to submit small chunks of related changes.
- Unrelated changes can be difficult to track, find and verify.
- Please don't bundle it with other unrelated changes (i.e. a bug fix or other enhancement)
Community Effort
The ZMK developers will not be running the show for this work. We've other priorities, so we'll only be signing off the PRs. It's up to the community to do the legwork which is a great opportunity for anyone to contribute to ZMK!
Future
Once codes are verified, it should become clear which codes are supported, which can be safely removed (obsolete), and which merit further attention. We expect this to be a slow process for the less popular codes.