Commit graph

405 commits

Author SHA1 Message Date
Nick
1ac78498eb docs: Set prettier endOfLine to auto
As discussed in PR #301.
2020-10-26 05:28:31 +00:00
Nick
fd892d53cd fix: eslint proptype errors 2020-10-25 23:45:28 +00:00
innovaker
288e60ea97 docs: Format docs with prettier
npx prettier --write .
2020-10-25 21:25:08 +00:00
innovaker
aefcc592f2 docs: Add eslint-mdx support
Official guidelines:
https://github.com/mdx-js/eslint-mdx

Steps taken:
npm i -D eslint-plugin-mdx
Edit .eslintrc.js
2020-10-25 21:25:01 +00:00
innovaker
18d4d619e4 docs: Add prettier support
Official guidelines:
https://prettier.io/docs/en/install.html
https://prettier.io/docs/en/integrating-with-linters.html
https://github.com/prettier/eslint-config-prettier

Steps taken:
npm install --save-dev --save-exact prettier
Create .prettierignore
Create .prettierrc.js
npm install --save-dev eslint-config-prettier
Edit .eslintrc.js
2020-10-25 21:24:55 +00:00
innovaker
ab65bf49db docs: Add eslint support
Official guidelines:
https://eslint.org/docs/user-guide/getting-started

Steps taken:
npm install eslint --save-dev
npx eslint --init
Create .eslintignore
Edit .eslintrc.js (tweaks)
2020-10-25 21:23:16 +00:00
Pete Johanson
b1bfff5b5a
Merge pull request #264 from careyk007/setup_sh__curl_always_required
Add support for wget to setup.sh
2020-10-25 23:39:47 -04:00
innovaker
ca0bcc0ae4 docs: Add missing docusaurus scripts
Add:
- docusaurus serve
- docusaurus clear
2020-10-25 19:45:04 +00:00
Nick
7296b96797 Add Reviung41 Shield Definitions 2020-10-24 21:08:00 -05:00
Pete Johanson
518bcacba1
Merge pull request #280 from Tsquash/txpowerdocs
DocumentedTX Power Config in Troubleshooting
2020-10-23 12:36:28 -04:00
Caleb Lightfoot
1a6d373d16 Added Sentence For Link to Zephyr Docs 2020-10-21 19:57:46 -05:00
Caleb Lightfoot
d07a46a334 Changed Wording of Text 2020-10-21 19:44:49 -05:00
innovaker
0905302006 chore(docs): Docusaurus 2.0.0-alpha.66 2020-10-21 19:35:04 +01:00
innovaker
1e008728b7 chore(blog): Remove deprecated id: wip
Fix warning ...
2020-05-24-wip.md - 'id' header option is deprecated. Please use 'slug' option instead.

Follow-up to #286.
2020-10-21 13:52:45 +01:00
innovaker
cd683b8dd6 chore(docs): Replace homePageId with slug: /
Fix warning ...
The docs plugin option homePageId=intro is deprecated. To make a doc the "home", prefer frontmatter: "slug: /"

Follow-up to #286.
2020-10-21 13:52:25 +01:00
innovaker
99751ad376 chore(docs): Docusaurus 2.0.0-alpha.65
Closes #286.  Prerequisite of #218.
2020-10-21 13:51:58 +01:00
innovaker
a796ee574f fix(docs): Remove empty links
Prerequisite fixes for Docusaurus 2.0.0-alpha.65 (#286) which has stricter markdown rules.
2020-10-21 13:51:37 +01:00
Pete Johanson
ef37f17796
Merge pull request #109 from Nicell/underglow/state-persistence
Add RGB underglow state Kconfig and settings
2020-10-18 22:29:55 -04:00
Kellen Carey
4bd41b9bf9 add wget flag to example 2020-10-15 16:53:16 -07:00
Pete Johanson
a1387eb041
Merge pull request #250 from Tsquash/docs
Added Feature Matrix for Intro.md
2020-10-15 11:24:15 -04:00
Pete Johanson
548fa2a6eb
Merge pull request #277 from megamind4089/docs/ext-power
Added docs for external power output
2020-10-15 11:18:42 -04:00
Caleb Lightfoot
91b208faf3 Documented TX Power Config in Troubleshooting 2020-10-13 21:12:29 -05:00
Pete Johanson
b2cad7e597 fix(docs): Proper block for romac shield. 2020-10-13 19:50:24 -04:00
Pete Johanson
43c900f94a feat: Add qaz to setup scripts. 2020-10-13 19:46:02 -04:00
Mega Mind
cc21167d57 Added docs for external power output 2020-10-14 00:27:32 +08:00
Pete Johanson
b193e5b1bc
Merge pull request #265 from kurtis-lew/actuallyissue138
Addressing #138 - ZMK Config Folders
2020-10-13 00:29:37 -04:00
Pete Johanson
94bc2c31b1 feat: Add a couple missing shields to user setup. 2020-10-13 00:23:25 -04:00
Pete Johanson
47cfcb42d2
Merge pull request #257 from kurtis-lew/issue138
Adressing Issue #181 - Split Keyboard Documentation
2020-10-13 00:04:12 -04:00
Caleb Lightfoot
e475260664 Revert "Increased Comprehension of Oled Footnote"
This reverts commit d4b83c3ebf.
2020-10-12 19:06:40 -05:00
Caleb Lightfoot
d4b83c3ebf Increased Comprehension of Oled Footnote 2020-10-12 18:52:29 -05:00
Pete Johanson
d0c6310434
Merge pull request #259 from Tsquash/DFU
Issue: #197 Added Setup Instructions for `dfu-util`
2020-10-12 11:08:21 -04:00
Pete Johanson
0d893e5fd2
Merge pull request #260 from Tsquash/PSscript
Issue #210 Document Setup.ps
2020-10-12 10:50:31 -04:00
Caleb Lightfoot
1ef21c57ea added links to see progress of features. 2020-10-10 23:03:07 -05:00
Caleb Lightfoot
593d7ff781 made table completely visual; changed feature sentence 2020-10-10 22:40:14 -05:00
Tsquash
56ab812a67 fixed BLE part of table 2020-10-10 22:18:18 -05:00
Tsquash
229c8b4358 Added BlueMicro Collumn 2020-10-10 22:18:18 -05:00
Tsquash
21987d3385 update intro.md 2020-10-10 22:18:18 -05:00
Tsquash
d7bfe979c9 Fixed Footnote and added user config repo 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
eb9dc37f00 fix table 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
e2a845b2eb removed checkmark from zmk oled 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
93c5ae17ac Uniformed Capitals, Added footnotes 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
910e207dbc Update Intro
changed intro wording and link to layer tap
Update intro.md
2020-10-10 22:18:18 -05:00
Tsquash
e740a83d68 Made columns wider 2020-10-10 22:17:52 -05:00
Tsquash
90b56a1941 added in dev 2020-10-10 22:17:52 -05:00
Tsquash
23e9cbcaf9 Added Table and fixed Feature sentence
added feature table

new feature sentence
2020-10-10 22:17:52 -05:00
kurtis-lew
677746014c Addressing #138 - ZMK Config Folders 2020-10-10 19:33:47 -07:00
Kellen Carey
b738cc9d75 add option to use wget 2020-10-10 19:16:07 -07:00
Kellen Carey
f9e8866a52 add support for wget to setup.sh 2020-10-10 18:28:16 -07:00
Pete Johanson
a7e8655287
Merge pull request #256 from careyk007/check_directory_write_permissions_in_setup_script
Exit setup if no write permissions in directory
2020-10-10 20:09:55 -04:00
Kellen Carey
4aa45c6f40
update setup.ps1 2020-10-10 17:00:13 -07:00
Tsquash
d79811dd61 Changed setup script url 2020-10-10 14:39:12 -05:00
Tsquash
45f4ffc03a added PowerShell setup Command 2020-10-10 13:03:34 -05:00
Tsquash
8d4e80c23a Added Dfu-Util to setup instructions 2020-10-10 11:10:17 -05:00
Kurtis Lew
fc6c01fd69
-DZMK_CONFIG Documentation (#255)
feat(docs): `-DZMK_CONFIG` Documentation
2020-10-09 23:56:52 -04:00
Idan Gazit
5401afc002
Skip toolchain for docker 2020-10-09 19:10:07 -07:00
Idan Gazit
5c00c97e9a
Wrap up documentation 2020-10-09 19:09:11 -07:00
Idan Gazit
15614a946f
WIP docs for docker development 2020-10-09 19:09:08 -07:00
Kellen Carey
b64517943d add powershell check 2020-10-09 18:53:21 -07:00
kurtis-lew
3322c3cab1 Adressing Issue #138 2020-10-09 18:51:51 -07:00
Kellen Carey
10029c297e exit setup if no write permissions in directory 2020-10-09 18:00:11 -07:00
Pete Johanson
405ca7267f
Merge pull request #254 from kurtis-lew/docissue220
Documented Issue #220
2020-10-09 16:02:25 -04:00
kurtis-lew
1f2bdf639f Adjusted Wording, Added link to GH Actions 2020-10-09 12:57:07 -07:00
Pete Johanson
81a4ffef7e feat(setup): Add Microdox to setup scripts. 2020-10-09 15:44:39 -04:00
Pete Johanson
e53320a687 fix(docs): Remove hanging footnote. 2020-10-09 11:57:34 -04:00
kurtis-lew
7128808bba Revert "Added -DZMK_CONFIG Documentation"
This reverts commit a9ec1148e5.
2020-10-09 08:19:50 -07:00
kurtis-lew
e03b51fe2e Revert "Addressing Issue #181"
This reverts commit 49315c2f6d.
2020-10-09 08:19:46 -07:00
kurtis-lew
429c9dc464 Revert "Addressed Issue #181"
This reverts commit dbda99a378.
2020-10-09 08:19:40 -07:00
kurtis-lew
aca801d90f Revert "Removed blank space"
This reverts commit c27d3c66f1.
2020-10-09 08:19:08 -07:00
kurtis-lew
a58a8412c7 Documented Issue #220 2020-10-09 08:15:38 -07:00
kurtis-lew
c27d3c66f1 Removed blank space 2020-10-08 22:21:49 -07:00
kurtis-lew
dbda99a378 Addressed Issue #181 2020-10-08 22:19:26 -07:00
kurtis-lew
49315c2f6d Addressing Issue #181 2020-10-08 22:18:53 -07:00
kurtis-lew
a9ec1148e5 Added -DZMK_CONFIG Documentation 2020-10-08 22:16:53 -07:00
Kevin
ea05df0290 docs: Added link to clarify where to add sensor-bindings code 2020-10-08 21:44:32 -07:00
Tyler Walker
a8d48b043d add benign uf2 transfer error for macOS to troubleshooting 2020-10-08 18:42:55 -04:00
Ben Huddleston
2300ce306a
Correct typo in previous profile behaviour binding in bluetooth.md 2020-10-07 22:25:21 +01:00
Pete Johanson
4de7cc45de feat(setup): Add M.2 and M60 to setup scripts. 2020-10-05 09:43:05 -04:00
Kevin
6427e64df3 fix(docs): Reorganized section in Windows setup 2020-10-04 17:10:34 -07:00
Kevin
31e481954f fix(docs): Fixed Python environment variables and commands for Windows setup 2020-10-04 17:03:56 -07:00
Pete Johanson
dfb4f1277d fix(docs): Proper emphasis of MUST NOT. 2020-10-02 23:17:53 -04:00
Pete Johanson
9a3d515583 fix(docs): Link to nice!nano product page itself. 2020-10-01 15:40:39 -04:00
Pete Johanson
819c82547d
Merge pull request #180 from CrossR/CrossR/ShellScriptTidyUp
Shell script tidy up.
2020-09-24 14:36:07 -04:00
Pete Johanson
d5ec32612d feat(docs): Add missing shields to hardware page. 2020-09-24 14:34:38 -04:00
CrossR
cd194dbac4 Add licenses. 2020-09-24 19:28:02 +01:00
Pete Johanson
a7ef79e3f8 feat(blog): SOTF #2 initial work.- Closes #182 2020-09-21 23:04:22 -04:00
CrossR
550c35db23 Fix PR comments, add error checking for push. 2020-09-20 12:52:25 +01:00
Pete Johanson
9b89ed7be4
Merge pull request #187 from kurtis-lew/main
Fixed Iris default build/Updated Dev Guide
2020-09-19 23:12:17 -04:00
Nick
18d21b0362 Merge remote-tracking branch 'upstream/main' into underglow/state-persistence 2020-09-15 14:41:59 -05:00
Kurtis Lew
ec86500524
Update dev-guide-new-shield.md 2020-09-14 20:53:26 -07:00
Kurtis Lew
0f8561daa1
Update dev-guide-new-shield.md 2020-09-14 20:46:42 -07:00
kurtis-lew
f6932992d2 Revert "Revert "Merge pull request #1 from zmkfirmware/main""
This reverts commit 5383bdd4df.
2020-09-14 20:39:30 -07:00
kurtis-lew
5383bdd4df Revert "Merge pull request #1 from zmkfirmware/main"
This reverts commit 36da21b8e3, reversing
changes made to 719db13c41.
2020-09-14 20:38:58 -07:00
kurtis-lew
1a492f0f98 Updated dev guide 2020-09-14 20:37:26 -07:00
Pete Johanson
676288fef2
Merge pull request #159 from okke-formsma/docs-update
update intro page, add layer-tap docs and update hold-tap docs.
2020-09-14 10:14:15 -04:00
Pete Johanson
6c8b0b53f0 refactor(bluetooth): More concise names. 2020-09-13 22:33:31 -04:00
Pete Johanson
39f980a06d feat(bluetooth): Add back profiles, split fixes.
* Add back in profiles, not using Zephyr
  BT identity infrastructure.
* Restore additional `&bt` commands for profile
  operations.
* Fix for split pairing and subscriptions, since
  Zephyr persists subscriptions across connects.
* Remove keymap from peripheral builds, reduces
  firmware size, and avoids unneeded attempts
  to send HID data.
2020-09-13 22:33:29 -04:00
Pete Johanson
fc0812bd2e fix(bluetooth): Remove identity, minimal bt.
* Simplify the `bt` behavior to one current command
  `BT_CLEAR_BONDS_CMD`.
* Simplify BLE code for split and non-split keyboards.
* Remove keymap processing from split peripheral side.
2020-09-13 22:33:05 -04:00
Pete Johanson
cf970efb98 feat(bluetooth): Proper bond management, identity support for non-splits
* Add `bt` behavior that can be used to perform certain actions,
  such as next/prev identity, reset identity, etc.
  NOTE: Multiple identities is only supported for non-split shields,
  due to missing Zephyr identity functionality for dual
  central/peripheral devices.
* Proper bond reset tied to action, that honors peripheral bonds,
  so folks can reset and pair to other hosts, without breaking
  bonds between splt halves.
2020-09-13 22:33:05 -04:00
Okke Formsma
763d62f6f2 update intro page, add layer-tap docs and update hold-tap docs. 2020-09-13 21:17:56 +02:00
CrossR
595dff6871 Add PowerShell script and tidy up bash script. 2020-09-13 18:07:45 +01:00
Pete Johanson
304603240f
Merge pull request #173 from LowNightSnack/main
Resolved #171
2020-09-11 14:31:01 -04:00
Mamoor Jaan Khan
e11cad9fde
Update hold-tap.md 2020-09-11 23:49:12 +05:30
Mamoor Jaan Khan
ce8ade4afa
A bad commit 2020-09-11 23:48:53 +05:30
Mamoor Jaan Khan
54437db0ba
Update with the examples 2020-09-11 20:42:33 +05:30
Mamoor Jaan Khan
98bd4796cf
Reverting previous commit 2020-09-11 20:40:19 +05:30
Mamoor Jaan Khan
7f5235904a
Reverting previous commit 2020-09-11 20:37:57 +05:30
Mamoor Jaan Khan
178e5e5afb
Reverting provious commit 2020-09-11 20:37:05 +05:30
Mamoor Jaan Khan
6d7fb6c48d
Update dev-clean-room.md 2020-09-11 20:10:23 +05:30
Mamoor Jaan Khan
c20eb9abac
Update hold-tap.md 2020-09-11 20:01:46 +05:30
Mamoor Jaan Khan
4ce70831dd
Update dev-guide-new-shield.md 2020-09-11 19:54:03 +05:30
Mamoor Jaan Khan
e660e56dfb
Update dev-boards-shields-keymaps.md 2020-09-11 19:52:32 +05:30
Mamoor Jaan Khan
69e6a99180
Add files via upload 2020-09-11 19:49:46 +05:30
Mamoor Jaan Khan
ce862d148d
Delete pro-micro-labelled-image.jpg 2020-09-11 19:47:20 +05:30
Cody McGinnis
cd00c0aad4
fix(docs): Fix the example mod tap configuration 2020-09-11 02:28:55 -04:00
Mamoor Jaan Khan
89ba824b2b
typo 2020-09-11 11:04:58 +05:30
Pete Johanson
3f9bb3edab
Merge pull request #175 from kurtis-lew/troubleshooting
Added File Transfer Error/CMake Warning Docs
2020-09-11 00:02:36 -04:00
Kurtis Lew
5b38fcff71
Reversed pairing instructions 2020-09-10 18:44:39 -07:00
kurtis-lew
073f5c8b98 Added File Transfer Error/CMake Warning Docs 2020-09-10 18:40:07 -07:00
Mamoor Jaan Khan
92b3ea8a6b
Update dev-guide-new-shield.md 2020-09-10 10:04:15 +05:30
Mamoor Jaan Khan
3c9f58f9d4
Update dev-boards-shields-keymaps.md 2020-09-10 10:03:48 +05:30
Mamoor Jaan Khan
d02fc07c4f
Update dev-boards-shields-keymaps.md 2020-09-10 10:02:25 +05:30
Mamoor Jaan Khan
82ddf81fcb
Update dev-guide-new-shield.md 2020-09-10 09:59:33 +05:30
Mamoor Jaan Khan
6a0e85ea72
labelled image to be added 2020-09-10 09:54:22 +05:30
Pete Johanson
e796e7c3e6
Merge pull request #165 from kurtis-lew/troubleshooting
Troubleshooting - Revised Copy of PR 150
2020-09-09 23:15:21 -04:00
Alexander Elias
6456fab8e0
Should this be org instead of com? 2020-09-09 09:14:01 -07:00
Pete Johanson
df2da813f1 fix(docs): Remove broken Discord invite links. 2020-09-08 16:08:09 -04:00
Kurtis Lew
618c537be1
Updated Headers 2020-09-06 20:45:28 -07:00
kurtis-lew
336cae9d0f Adjusted lines to fix caption format 2020-09-06 20:13:45 -07:00
kurtis-lew
cb95b9f11a Restored Troubleshooting.md and associated files 2020-09-06 20:03:33 -07:00
kurtis-lew
bdeb6865e1 Update sidebars.js 2020-09-06 19:55:56 -07:00
Pete Johanson
61b249666b
Merge pull request #163 from bmcgavin/non-split-template
Add RoMac / non-split template support
2020-09-06 13:02:50 -04:00
Richard Jones
01da54aadf
point setup.sh at upstream 2020-09-06 17:54:45 +01:00
Pete Johanson
ba07fd1879
Merge pull request #154 from chenkevinh/docs/encoders
Encoder documentation
2020-09-06 12:23:11 -04:00
Richard Jones
80034c0078 Add RoMac / non-split template support 2020-09-06 15:51:12 +01:00
CrossR
df422e0205 Revert changes to Intro page. 2020-09-04 20:47:21 +01:00
CrossR
89d604b74b Clarify low power mode wording. 2020-09-04 19:31:04 +01:00
CrossR
0ede549a13 Fix Sofle build, update Intro page. 2020-09-03 22:54:06 +01:00
Pete Johanson
e559cb2d71 Add hold-tap to sidebar. 2020-09-03 10:14:16 -04:00
Kevin
e904a098b3 Added keymap update to encoder docs 2020-09-02 21:12:22 -07:00
Pete Johanson
c8f95dbaa8
Merge pull request #155 from kurtis-lew/iris
Update setup.sh
2020-09-03 00:05:06 -04:00
Kurtis Lew
f738fd7a67
Update setup.sh 2020-09-02 20:57:42 -07:00
kurtis-lew
9b1fd1323f Update setup.sh 2020-09-02 20:53:14 -07:00
Kevin
5eb50d7b18 Fixed links 2020-09-02 18:36:35 -07:00
Kevin
2629aa354f Removed old dev encoder page 2020-09-02 18:28:00 -07:00
Kevin
6f74e61dd3 Added user and dev encoder docs 2020-09-02 18:25:46 -07:00
Kevin
5b493ef334 Merge branch 'main' into docs/encoders
Sync with upstream
2020-09-02 17:37:39 -07:00
Pete Johanson
48a3729ffe
Merge pull request #146 from okke-formsma/hold-tap
Hold-Tap implementation
2020-09-02 13:55:26 -04:00
Okke Formsma
c9a82d71d0 fixes for feedback round 2 2020-09-02 16:41:39 +02:00
Okke Formsma
c5ca664411 some fixes based on feedback 2020-09-02 15:26:06 +02:00
Kevin
068626d1a7 Some work on encoder docs 2020-09-01 21:12:09 -07:00