Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

refactor(docs): Refer to overview page for behaviors

Browse Source
This commit is contained in:
Cem Aksoylar
2024-03-24 17:58:20 -07:00
parent f2d8b9b0a3
commit c684cee76f
3 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/development/new-behavior.mdx
View File

@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
## Overview
This document outlines how to develop a behavior for ZMK and prepare the changes for a pull request.
This document outlines how to develop a [behavior](../behaviors/index.mdx) for ZMK and prepare the changes for a pull request.
Behaviors are assigned to key positions and determine what happens when they are pressed and released. They are implemented in Zephyr as "devices": they consist of a devicetree binding file, which specifies the properties of the behavior, and a driver written in C code. This allows for the ability to create unique instances of these behaviors in [keymaps](../features/keymaps.mdx) or devicetree-source-include files (`.dtsi`). While instances of behaviors stored in keymaps are created by end-users for their personal needs, the instances that live in the .dtsi files are stored and documented in ZMK directly, which removes the need for end-users to set up common use-cases of these behaviors in their personal keymaps.

2
docs/docs/development/new-shield.mdx
View File

@@ -386,7 +386,7 @@ The two `#include` lines at the top of the keymap are required in order to bring
### Keymap Behaviors
For the full documentation on the available behaviors for use in keymaps, start with reviewing [`kp`](../behaviors/key-press.md) and then use the sidebar to review the others available within ZMK.
For documentation on the available behaviors for use in keymaps, see the [overview page for behaviors](../behaviors/index.mdx).
## Metadata