pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
zmk_mf68/docs/sidebars.js

92 lines
2.1 KiB
JavaScript
Raw Normal View History

Initial work on basic documentation.
2020-05-26 11:33:21 +10:00
module.exports = {
docs: Rename `someSidebar` to `docs`
2020-11-13 01:41:03 +11:00
docs: {
Add hold-tap to sidebar.
2020-09-04 00:14:16 +10:00
"Getting Started": [
"intro",
"hardware",
"faq",
"user-setup",
"customization",
docs: Format docs with prettier npx prettier --write .
2020-10-26 04:23:51 +11:00
"troubleshooting",
Add hold-tap to sidebar.
2020-09-04 00:14:16 +10:00
],
Docs re-org, start of some keymap docs.
2020-08-07 05:04:31 +10:00
Features: [
refactor(docs): Change `feature` to `features` Makes a better URL.
2020-11-12 08:24:19 +11:00
"features/keymaps",
refactor(docs): Move combos under Features. * Since combos aren't a behavior, but a new high level keymap feature, move under Features section.
2021-01-24 15:50:30 +11:00
"features/combos",
docs(conditional-layers): Document feature
2021-10-02 12:05:37 +10:00
"features/conditional-layers",
feat(kscan): Improve matrix debouncing Switched the GPIO matrix driver to debouncing using a simple integrator algorithm. Whenever a key is pressed, we now scan at a rate controlled by debounce-scan-period-ms (default 1 ms) until all keys are released, then return to either waiting for an interrupt or polling more slowly. The timers for key press and release can now be controlled separately, so debounce-period is deprecated in favor of debounce-press-ms and debounce-release-ms. Global Kconfig options ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also added to make these easier to set. Added documentation for debouncing options.
2021-07-31 16:23:33 +10:00
"features/debouncing",
refactor(docs): Change `feature` to `features` Makes a better URL.
2020-11-12 08:24:19 +11:00
"features/displays",
"features/encoders",
"features/underglow",
feat(docs): add backlight documentation
2021-10-10 03:25:00 +11:00
"features/backlight",
feat(docs): Add battery sensor documentation
2022-04-16 14:17:38 +10:00
"features/battery",
change "Under Development" to "Beta Testing"
2021-03-08 02:47:44 +11:00
"features/beta-testing",
Docs re-org, start of some keymap docs.
2020-08-07 05:04:31 +10:00
],
Add lighting behavior docs
2020-08-09 08:23:11 +10:00
Behaviors: [
refactor(docs): Change `behavior` to `behaviors` Makes a better URL.
2020-11-12 08:25:32 +11:00
"behaviors/key-press",
"behaviors/layers",
"behaviors/misc",
"behaviors/hold-tap",
"behaviors/mod-tap",
Docs: added mod morph page (#749) * docs(behaviors): add mod-morph doc page * docs(behaviors): add mod-morph doc page * docs(mod-morph): add note about sent modifiers * docs(mod-morph): fixed prettier formatting
2021-04-06 09:04:38 +10:00
"behaviors/mod-morph",
feat(docs): Document the macro behavior.
2022-03-16 15:09:10 +11:00
"behaviors/macros",
feat(docs): Add docs for key toggle behavior
2022-05-03 13:47:50 +10:00
"behaviors/key-toggle",
docs(sticky keys): document sticky keys and sticky layers
2020-12-14 00:33:28 +11:00
"behaviors/sticky-key",
"behaviors/sticky-layer",
feat(behaviors): Add Tap-Dance behavior
2022-03-16 16:08:42 +11:00
"behaviors/tap-dance",
feat(behaviors): Add caps word (`&caps_word`). * Add new `&caps_word` behavior that acts like caps lock, but releases automatically when any "break" keycode is pressed.
2021-06-09 16:10:20 +10:00
"behaviors/caps-word",
fix(docs): Add `behaviors/key-repeat` to sidebar
2022-02-12 19:46:08 +11:00
"behaviors/key-repeat",
refactor(docs): Change `behavior` to `behaviors` Makes a better URL.
2020-11-12 08:25:32 +11:00
"behaviors/reset",
"behaviors/bluetooth",
"behaviors/outputs",
feat(docs): add backlight documentation
2021-10-10 03:25:00 +11:00
"behaviors/underglow",
"behaviors/backlight",
refactor(docs): Change `behavior` to `behaviors` Makes a better URL.
2020-11-12 08:25:32 +11:00
"behaviors/power",
Add lighting behavior docs
2020-08-09 08:23:11 +10:00
],
docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-11-07 06:42:54 +11:00
Codes: [
"codes/index",
"codes/keyboard-keypad",
docs(codes): add modifier functions Refactor and expand codes documentation to include modifier functions. Closes #330.
2020-11-07 07:34:36 +11:00
"codes/modifiers",
docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-11-07 06:42:54 +11:00
"codes/editing",
"codes/media",
"codes/applications",
"codes/input-assist",
"codes/power",
feat(docs): add keymap upgrader Added a documentation page with a script that upgrades deprecated key codes and behaviors to their replacements. Fixes #299
2020-11-08 11:03:20 +11:00
"codes/keymap-upgrader",
docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-11-07 06:42:54 +11:00
],
docs: Add documentation for config options
2021-03-07 13:06:15 +11:00
Configuration: [
"config/index",
feat(docs): Updating lighting config docs
2022-04-30 12:21:07 +10:00
"config/backlight",
feat(docs): Update power and lighting config pages Moved battery configuration to its own page to match the feature page. Documented that external power is disabled when in sleep mode. Clarified that the *_START configs apply on first boot, and any changes after that are persisted.
2022-05-22 08:48:27 +10:00
"config/battery",
docs: Add documentation for config options
2021-03-07 13:06:15 +11:00
"config/behaviors",
"config/combos",
"config/displays",
"config/encoders",
"config/keymap",
"config/kscan",
"config/power",
"config/underglow",
feat(docs): Update power and lighting config pages Moved battery configuration to its own page to match the feature page. Documented that external power is disabled when in sleep mode. Clarified that the *_START configs apply on first boot, and any changes after that are persisted.
2022-05-22 08:48:27 +10:00
"config/system",
docs: Add documentation for config options
2021-03-07 13:06:15 +11:00
],
Expanded dev docs on boards/shields/keymaps.
2020-07-07 01:40:03 +10:00
Development: [
refactor(docs): Move `dev-` documents into `/development` Aligns to conventions introduced by newer documentation.
2020-11-12 23:18:45 +11:00
"development/clean-room",
feat(docs): add information on how to update the documentation to the docs
2020-11-28 09:04:15 +11:00
"development/documentation",
refactor(docs): Move `dev-` documents into `/development` Aligns to conventions introduced by newer documentation.
2020-11-12 23:18:45 +11:00
"development/setup",
"development/build-flash",
"development/boards-shields-keymaps",
"development/posix-board",
"development/tests",
refactor(docs): Integrate `USB Logging` into `Development` section Improves discoverability.
2020-11-13 00:33:25 +11:00
"development/usb-logging",
docs: Add docs for setting up vscode Added a docs page with tips for setting up VS Code's code completion to work in ZMK's source files. Info for other IDEs can be added here later as needed.
2020-09-20 07:32:24 +10:00
"development/ide-integration",
refactor(docs): Integrate `Dev Guides` into `Development` section Improves discoverability.
2020-11-13 00:38:35 +11:00
{
type: "category",
label: "Guides",
collapsed: false,
docs: Add docs on hardware metadata files.
2021-07-28 14:55:36 +10:00
items: [
"development/new-shield",
"development/hardware-metadata-files",
feat(docs): Add New Behavior Guide Co-authored-by: Henré Botha <henrebotha@gmail.com> Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com> Co-authored-by: Dom H <dom@hxy.io> Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2022-05-22 02:26:10 +10:00
"development/new-behavior",
docs: Add docs on hardware metadata files.
2021-07-28 14:55:36 +10:00
],
refactor(docs): Integrate `Dev Guides` into `Development` section Improves discoverability.
2020-11-13 00:38:35 +11:00
},
refactor(docs): Move `dev-` documents into `/development` Aligns to conventions introduced by newer documentation.
2020-11-12 23:18:45 +11:00
],
Initial work on basic documentation.
2020-05-26 11:33:21 +10:00
},
};
Reference in a new issue Copy permalink