feat(docs): Add keymap recipes section #1953
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Recipes document distinct functionality provided by novel use of existing config, features, and behaviors. n.b. All pages are currently only placeholders. All names are tentative.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(Opening to replace #1952 for the branch to be part of the
zmkfirmware/zmkrepo, thanks for getting this going @SethMilliken! Copied the description verbatim.)ZMK enables myriad functionality that is technically neither feature nor behavior, but typically results from novel composition of configuration, features, and behaviors. Questions about this class of functionality often arise in Discord server discussion, and the techniques to implement them are currently passed on informally by reference to personal configurations. Having official documentation for this functionality could help with standardization and transmission of these techniques.
The name "recipes" seems to capture the nature of this type of functionality.
Some examples of recipes include:
This draft PR is intended to explore documenting these recipes, and to refine the definition of a "recipe".
Tasks:
Feel free to contribute using comments here, comments in the #documentation channel in the Discord, or directly as PRs targeting this branch (
docs/recipes). Once we have above tasks completed, this PR will be published.ZMK Discord discussion where this idea originated.