Commit Graph

84 Commits

Author SHA1 Message Date
Nicolas Munnich 5f056f7199
refactor(docs): Convert the keymaps section into a base folder (#2430)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-21 10:39:18 -07:00
Peter Johanson feda96eb40 feat(studio): Initial RPC infrastructure and subsystems.
* UART and BLE/GATT transports for a protobuf encoded RPC
  request/response protocol.
* Custom framing protocol is used to frame a give message.
* Requests/responses are divided into major "subsystems" which
  handle requests and create response messages.
* Notification support, including mapping local events to RPC
  notifications by a given subsystem.
* Meta responses for "no response" and "unlock needed".
* Initial basic lock state support in a new core section, and allow specifying
  if a given RPC callback requires unlocked state or not.
* Add behavior subsystem with full metadata support and examples of
  using callback to serialize a repeated field without extra stack space needed.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-15 11:45:18 -06:00
Cem Aksoylar 96cd3a1ce2 refactor(docs): Remove unnecessary jsx includes 2024-08-13 23:03:15 -07:00
Cem Aksoylar 4faeb365b1 feat(docs): Add keyboard vs consumer variants note 2024-08-13 23:03:15 -07:00
Nicolas Munnich 308d6bce6e
feat(docs): Improve the toolchain setup page (#2272)
Split the toolchain setup into separate docker and native pages
and improve instructions to better refer to Zephyr docs in certain steps.
Also refactor to improve consistency and add virtualenv instructions.

---------

Co-authored-by: KemoNine <mcrosson@kemonine.info>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-06-01 21:51:08 -07:00
Horu 7d1f84e3eb
chore: fix typos in various places 2024-05-13 16:47:33 -04:00
zhiayang 4bef4e98f5
feat(boards): Support board revisions in setup scripts.
* Make setup.sh/ps1 prompt for board revision for boards that have revisions
2024-03-30 19:12:37 -04:00
Joel Spadin 3a4cf185a1 feat(keymap-upgrader): Upgrade encoder resolution
Added an upgrade function to the keymap upgrader to replace the encoder
"resolution" property with "steps" and (if it is not already present)
"triggers-per-rotation".
2024-02-03 18:45:21 -06:00
Joel Spadin be75da096c fix(keymap-upgrader): Fix highlight on last line
Fixed an issue where a text edit at the very end of a file would cause
it to highlight from the start of the edit to the start of the file
instead of to the end of the file.
2024-02-03 18:45:21 -06:00
Joel Spadin 08d9391a8a feat(keymap-upgrader): Upgrade renamed nodes
Added an upgrade function to fix renamed behavior nodes in the unlikely
event that someone was changing behavior settings this way instead of
using references.
2024-01-25 18:03:37 -06:00
Joel Spadin bf5284b3b9 fix(keymap-upgrader): Note that changed lines are highlighted 2024-01-25 18:03:37 -06:00
Joel Spadin d4be70587d fix(keymap-upgrader): Filter key codes to bindings
Changed the key code upgrader to only replace codes that appear in
"bindings" properties. Modifier flags such as MOD_LCTL are no longer
valid as key codes, but they are still used in "mods" properties and
should not be replaced there.
2024-01-25 18:03:37 -06:00
Joel Spadin 37fcf190e6 feat(keymap-upgrader): Highlight changes
Updated the keymap upgrader to highlight which lines it changed as well
as indicate when nothing needed to be upgraded.

Also adjusted the line highlight colors to be more readable in both
light and dark color schemes.
2024-01-25 18:03:37 -06:00
Joel Spadin a0465391be refactor: Improve keymap upgrader
Moved the keymap upgrader to a top-level page like the power profiler
to make it more discoverable. It upgrades more things than key codes
now, so putting it in the codes category doesn't make much sense.

Converted the upgrader code to TypeScript and split it up into smaller
files to make it easier to add new upgrade functions.

Added upgrade functions to remove/replace "label" properties and rename
matrix-transform.h to matrix_transform.h.
2024-01-25 18:03:37 -06:00
Cem Aksoylar 00962a7255 refactor(docs): Remove no longer necessary React imports 2024-01-20 22:28:41 -08:00
Cem Aksoylar a0a952413a fix(docs): Fix deprecated admonition types 2024-01-20 22:28:41 -08:00
crides 8c14b155e8 docs: confirm some consumer codes on iOS
Tested on iOS 16.6
2024-01-15 18:07:48 -08:00
ReFil 6c75d6986c feat(docs): Document globe key specific quirks 2023-10-10 14:04:28 -07:00
Joel Spadin 4a339093ce docs: Add highlighting for devicetree and kconfig
Added syntax highlighting for devicetree and kconfig files.

The PrismJS project is not accepting contributions right now as they
work on a version 2 of the library, so the new language files are added
directly here.

Also enabled syntax highlighting for various languages that are used in
the docs but aren't enabled in Docusaurus by default.
2023-10-09 15:19:24 -07:00
ReFil c1ebadcd2a
feat(hid): Add apple globe keycode
* feat(hid): Add apple globe keycode
* Update docs/src/data/hid.js

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
Co-authored-by: Nick Coutsos <nick@coutsos.com>
2023-09-29 13:14:31 -07:00
kadoyau 98524a9567
fix(docs): Fix INT6 keycode description 2023-06-10 12:32:50 -07:00
Joel Spadin dae020787e docs: Update tree-sitter
Updated web-tree-sitter and the devicetree grammar.

web-tree-sitter now supports a custom function to locate its .wasm file,
so performing a string replace is no longer necessary to get it to work
with Docusaurus' Webpack configuration. We now check when tree-sitter is
locating its .wasm file and provide the Webpack-adjusted URL.
2023-05-20 01:33:11 -06:00
Joel Spadin 9bd171ede4 fix(docs): Add key to interconnect tabs
Added a key property to interconnect tabs list items to fix a React
warning.
2023-04-25 15:50:38 -07:00
Joel Spadin 32ae776c42 refactor: Add more checks to pre-commit
Updated existing pre-commit hooks and added some new hooks:

- Remove trailing whitespace
- Ensure every non-empty file ends with a new line
- Check YAML file validity
- Prevent adding large files
- Ensure any scripts with shebangs are executable

Added a GitHub action to run pre-commit on every commit. Removed any
existing actions which duplicate pre-commit.

Ran pre-commit on the codebase.
2023-04-24 16:07:04 -07:00
Peter Johanson 35a1c5a3d4 refactor(behaviors): Rename `reset` behavior.
* Upstream now has a node w/ label `reset` on many boards, so
  renaming our reset behavior node label to `sys_reset`.
2023-04-05 22:55:38 -07:00
Peter Johanson c23443a086 feat(docs): Generate new shield interconnect docs.
* Add to metadata schema for interconnects.
* New conventional location for pinout diagrams/pics.
* New component to generate the tabs for the new shield
  doc section on interconnects.
* Add XIAO and arduino uno pinout diagram.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-23 02:41:35 -06:00
Cem Aksoylar 781df31ec4 fix(setup): Fix conf download path in PS script 2022-12-17 17:46:22 -06:00
Cem Aksoylar b8fb218a01 fix(setup): Make keymap/conf fall back to using dirname 2022-12-16 17:41:39 -06:00
Peter Johanson f03e29ca13 fix(config): Fix split wired detection in setup.sh. 2022-12-11 09:29:58 -06:00
Peter Johanson a02eb28271 fix(docs): Move to `data-tooltip` for profiler.
* Fix ESLint warning by using `data-` prefixed custom attr.
2022-10-26 23:02:54 -05:00
ebastler c9eb63199a
feat(keymaps): add NUHS/NUBS alias for Non-US-Backslash/Non-US-Hash 2022-10-17 21:48:19 -04:00
byran.tech 3f00f14e36
feat(docs): Added a Spelling Error Caution Notice 2022-10-15 14:00:09 -05:00
Nick Winans bdc706f88d
docs(power profiling): add nice!view 2022-10-07 20:43:12 -04:00
Joe Peterson a035fe4cc8 docs(codes): Windows Support: F20-F24
F20-24 are confirmed to work on Windows 11 via a web based keyboard
tester

Refs: #1476
2022-10-05 09:01:37 -04:00
Joe Peterson fd5e9e1403 docs(codes): Windows Support: F13-F19
F13-F19 are confirmed to work on Windows 11 in VSCode 1.71.2.

Refs: #1476
2022-10-05 09:01:37 -04:00
Nick Winans 3d3c45bc80
feature(shields): Add nice!view
* Use two shield system, nice_view, and nice_view_adapter
* Build system fixes for interconnect use.
2022-09-29 21:11:26 -04:00
Shreyas 391f80f069
feat(hid): Add C_AC_DESKTOP_SHOW_ALL_APPLICATIONS
* support for C_AC_DESKTOP_SHOW_ALL_APPLICATIONS

Co-authored-by: Shreyas Kale <shreyaskale@Shreyass-MacBook-Pro.local>
2022-08-22 00:27:47 -04:00
Stefán Páll Sturluson d7ba7a1bee
fix(codes): typo in C_SUBTITLES. 2022-05-17 00:29:53 -04:00
Peter Johanson 6227866e8c feat(setup): Disallow split w/ wired controller.
For now, disallow wired split combination during setup.
2022-05-03 05:10:09 -04:00
Peter Johanson c8c273d83b feat(docs): Add TOC to supported hardware page. 2022-04-19 07:05:26 -04:00
rhhub b79b6363a7
fix(docs): Clear up ambiguity on supported hardware page (#1200) 2022-03-30 08:51:12 +01:00
Joel Spadin ed41d42874 feat(docs): Add aggregated metadata to website
Added /hardware-metadata.json to the ZMK website.
This gives external tools a way to grab all hardware metadata at once.
2022-03-29 23:03:56 -04:00
Alessandro Bortolin f8bf8bffd5 feat(docs): add backlight to power profiler 2022-02-05 23:40:18 -05:00
KingCoinless e7a52e2cee
docs(codes): Windows Support: Media Controls
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-01-02 10:44:55 +00:00
Kiessling 7b2edbad43 docs(codes): Windows Support: Language/International Inputs 2021-12-29 10:43:02 +00:00
Kiessling 1e4f0147ad docs(codes): Windows Support: Audio Controls 2021-12-29 10:42:34 +00:00
Kiessling 4a547555bf docs(codes): Windows Support: Workflow Commands and Locks 2021-12-29 10:41:58 +00:00
Kiessling ee0f24412b docs(codes): Windows Support: Symbols, Operations, and Punctuation 2021-12-29 10:41:30 +00:00
KingCoinless 3879267615
docs(codes): Windows Support: Display Adjustment Commands
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-12-29 10:40:31 +00:00
Cem Aksoylar 93e76835e4 fix(setup): Use right flags for curl when wget doesn't exist. 2021-12-28 22:13:46 +00:00