zmk/docs/sidebars.js
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

152 lines
3.6 KiB
JavaScript

module.exports = {
docs: [
{
type: "category",
label: "Getting Started",
link: {
type: "doc",
id: "intro",
},
collapsed: false,
items: [
"hardware",
"faq",
"user-setup",
"customization",
{
type: "category",
label: "Troubleshooting",
link: {
type: "doc",
id: "troubleshooting/index",
},
collapsed: true,
items: [
"troubleshooting/building-issues",
"troubleshooting/flashing-issues",
"troubleshooting/connection-issues",
],
},
],
},
{
Features: [
"features/keymaps",
"features/bluetooth",
"features/split-keyboards",
"features/combos",
"features/conditional-layers",
"features/debouncing",
"features/displays",
"features/encoders",
"features/modules",
"features/underglow",
"features/backlight",
"features/battery",
"features/soft-off",
],
},
{
type: "category",
label: "Behaviors",
link: {
type: "doc",
id: "behaviors/index",
},
collapsed: true,
items: [
"behaviors/key-press",
"behaviors/layers",
"behaviors/misc",
"behaviors/hold-tap",
"behaviors/mod-tap",
"behaviors/mod-morph",
"behaviors/macros",
"behaviors/key-toggle",
"behaviors/sticky-key",
"behaviors/sticky-layer",
"behaviors/tap-dance",
"behaviors/caps-word",
"behaviors/key-repeat",
"behaviors/sensor-rotate",
"behaviors/mouse-emulation",
"behaviors/reset",
"behaviors/bluetooth",
"behaviors/outputs",
"behaviors/underglow",
"behaviors/backlight",
"behaviors/power",
"behaviors/soft-off",
],
},
{
Codes: [
"codes/index",
"codes/keyboard-keypad",
"codes/modifiers",
"codes/editing",
"codes/media",
"codes/applications",
"codes/input-assist",
"codes/power",
],
},
{
type: "category",
label: "Configuration",
link: {
type: "doc",
id: "config/index",
},
collapsed: true,
items: [
"config/backlight",
"config/battery",
"config/behaviors",
"config/bluetooth",
"config/combos",
"config/displays",
"config/encoders",
"config/keymap",
"config/kscan",
"config/power",
"config/underglow",
"config/system",
],
},
{
Development: [
"development/clean-room",
"development/pre-commit",
"development/documentation",
{
type: "category",
label: "Setup",
collapsed: true,
items: [
"development/setup/index",
"development/setup/docker",
"development/setup/native",
],
},
"development/build-flash",
"development/boards-shields-keymaps",
"development/posix-board",
"development/tests",
"development/usb-logging",
"development/ide-integration",
"development/studio-rpc-protocol",
{
type: "category",
label: "Guides",
collapsed: false,
items: [
"development/new-shield",
"development/hardware-metadata-files",
"development/new-behavior",
],
},
],
},
],
};