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
Okke Formsma
29a23f0182
Add tap-hold docs, update mod-tap docs
2020-09-01 19:41:08 +02:00
CrossR
ca0f2bb074
Add to setup.
2020-09-01 18:32:45 +01:00
Kurtis Lew
96fde77560
Update key-press.md
...
Specified keypress and consumer press pages
2020-08-30 20:12:53 -07:00
Kevin Chen
45b1756a70
Replaced \ with /
...
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2020-08-29 21:36:00 -07:00
Kevin
212dd91e29
PuTTY image fix
2020-08-29 21:27:03 -07:00
Kevin
06af711f57
Replaced png with jpg
2020-08-29 21:20:38 -07:00
Kevin
af23445aa0
COM image fix
2020-08-29 21:13:48 -07:00
Kevin
0e04596ef6
Renamed COM port image
2020-08-29 21:04:32 -07:00
Kevin
0a06760cda
Updated alt text
2020-08-29 19:26:11 -07:00
Kevin
8594d832b6
Added split build directories
2020-08-29 19:23:25 -07:00
Kevin
bc13cd1de1
Added PuTTY to USB Logging
2020-08-29 19:22:43 -07:00
Kevin
037970fe8c
Removed DKEYMAP and added split build directories
2020-08-29 18:43:13 -07:00
Kevin
276a2620b9
Minor capitalization fix
2020-08-29 17:47:41 -07:00
Kevin
dad2d339b3
Added customization page
2020-08-29 17:46:00 -07:00
Kevin
d7bd09149b
Added info on connecting keyboard
2020-08-29 17:25:37 -07:00
Kevin
76095c64c6
Fixed title
2020-08-29 17:25:00 -07:00
Kevin
133166c392
Pictures for environment variables
2020-08-29 17:23:17 -07:00
Kevin
9b9174cc57
Added lily58 reset photo
2020-08-29 17:22:39 -07:00
Kevin
96020a469a
Added win environment variables instructions
2020-08-29 17:21:56 -07:00
Kevin
35dc46bfbb
Made separate build and flash page with updated content
2020-08-29 15:51:08 -07:00
Kevin
ec6215f38e
Added Arduino IDE to USB Logging
2020-08-29 15:05:43 -07:00
Cody McGinnis
205a54baeb
fix(docs): update the testing docs
2020-08-28 16:21:31 -04:00
Cody McGinnis
26414a6982
fix(docs): move testing docs to website docs
2020-08-28 16:21:31 -04:00
crd
0c255aee84
[docs] Add bzip to deps
2020-08-22 09:29:23 -07:00
Pete Johanson
760de7d3c6
Merge pull request #92 from Na-Cly/shields/splitreus62
...
Add splitreus62 shield
2020-08-21 22:37:50 -04:00
Pete Johanson
805ea77005
feat(behaviors): Add &bootloader behavior.
...
* Allow reset behavior to have a type property.
* Add `bootloader` node that triggers DFU UF2
bootloader mode using the AdaFruit nrf52
bootloader.
2020-08-21 11:23:45 -04:00
Pete Johanson
1ff13676f7
fix(docs): Better behavior sidebar label/titles.
2020-08-21 00:31:28 -04:00
Nick
bee5f7c350
fix(rgb): add missing Kconfig docs
2020-08-20 21:13:05 -05:00
Derek
94c7d27f04
Updated files as per request
...
Updated
2020-08-20 15:13:51 -04:00
Pete Johanson
11e3566277
fix(docs): Link to 2.3.0 docs, macOS toolchain fix
...
* Link explicitly to the 2.3.0 docs from upstream
Zephyr.
* Update the macOS toolchain section to properly
refer to the 3rd party toolchain setup.
2020-08-20 00:11:07 -04:00
Pete Johanson
3576738ab4
Merge pull request #103 from BrainWart/bond-clearing
...
feat(docs): create a bond clearing page
2020-08-19 21:02:03 -04:00
Pete Johanson
506c3b031e
refactor(boards): Rename to bluemicro840_v1.
2020-08-19 16:35:18 -04:00
Cody McGinnis
02f541969c
fix(docs): make time to clear explicit
2020-08-19 00:11:44 -04:00
Cody McGinnis
feadfc93dc
feat(docs): create a bond clearing page
2020-08-19 00:07:08 -04:00
Pete Johanson
d2d9fc86cf
feat(docs): Basic mod-tap behavior docs.
2020-08-18 15:24:38 -04:00
Pete Johanson
c054feb3c9
Merge pull request #100 from petejohanson/behaviors/add-none
...
Add `&none` behavior.
2020-08-18 14:31:20 -04:00
Pete Johanson
63e02d60dc
feat(behaviors): Add &none behavior
2020-08-18 14:28:11 -04:00
Pete Johanson
c667be1404
Merge pull request #98 from BrainWart/layer-toggle
...
Feature: Layer toggle
2020-08-18 14:25:03 -04:00
Pete Johanson
2ffe09b617
fix(docs): Fix typo in key press behavior doc.
2020-08-18 14:11:48 -04:00
Cody McGinnis
bb4f45a57a
fix(docs): add another example to toggle layer
2020-08-18 14:02:25 -04:00
Cody McGinnis
ae104374c0
feat(docs): document the toggle layer behavior
2020-08-18 14:02:24 -04:00
Pete Johanson
1607656c53
Note the fixed showstoppers.
2020-08-16 23:16:50 -04:00
Pete Johanson
3f1dfbaad1
Merge pull request #91 from Na-Cly/boards/bluemicro52840_v1
...
Add bluemicro support
2020-08-16 22:32:04 -04:00
Pete Johanson
abe40f8ef5
Various fixes.
2020-08-16 21:30:45 -04:00
Derek
17c43881b8
Updated select block
2020-08-16 13:43:59 -04:00
Derek
5bb01c802b
Update setup.sh
2020-08-16 08:49:17 -04:00
Derek
e554cbcbc3
Merge branch 'boards/bluemicro52840_v1' of https://github.com/Na-Cly/zmk into boards/bluemicro52840_v1
2020-08-16 08:45:22 -04:00
Derek
68da92f4dd
Update setup.sh
2020-08-16 08:45:03 -04:00
Derek
ba1cde94a8
Update docs/static/setup.sh
...
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2020-08-16 08:43:09 -04:00
Pete Johanson
94549b4a07
Merge pull request #89 from Nicell/underglow/fix-configs
...
Add missing configuration values for RGB underglow
2020-08-15 21:17:14 -04:00
Pete Johanson
ee5900686b
Fix the active/pull down flags for the example.
2020-08-15 21:13:50 -04:00
Pete Johanson
7e1942867b
Doc fixes for keymaps.
2020-08-15 20:20:19 -04:00
Derek
23b188330f
Update setup.sh
...
Updated setup.sh
2020-08-15 19:30:35 -04:00
Nick
2863f15006
Fix docs typos
2020-08-14 21:36:11 -05:00
Nick
aa4ae90fb7
Add missing configuration values for RGB underglow
2020-08-14 21:31:18 -05:00
Cody McGinnis
c3b4525d25
Fix edit url links for the website.
2020-08-13 00:19:59 -04:00
Pete Johanson
0624c6c54a
State Of The Firmware #1 .
2020-08-12 10:20:51 -04:00
Pete Johanson
a6ef1cddec
Add analytics.
2020-08-11 16:55:36 -04:00
Pete Johanson
47dbba2184
Fix sed -i usage on macOS, accept 'Y'.
2020-08-11 08:40:13 -04:00
Pete Johanson
b0c648ad57
Revert usage of read -i for macOS compat.
2020-08-10 22:47:18 -04:00
Pete Johanson
bc6b11eb02
Merge pull request #78 from Nicell/docs/rgb
...
Add RGB documentation
2020-08-10 13:46:46 -04:00
Pete Johanson
579ca63120
Merge pull request #80 from petejohanson/shields/corne-initial-definition
...
Initial Corne shield definition
2020-08-10 12:58:04 -04:00
Pete Johanson
4da2070a5b
Add Corne to hardware list.
2020-08-10 12:54:34 -04:00
CrossR
03a945d423
Move to correct location.
2020-08-10 17:51:54 +01:00
CrossR
3f74814379
Quick doc update.
2020-08-10 17:43:57 +01:00
Pete Johanson
851d54ad96
Add Corne to setup.sh script.
2020-08-10 12:37:05 -04:00
Nick
fd77fdb63d
Fix video container size
2020-08-08 19:10:10 -05:00
Nick
d901a0061d
Add underglow feature docs + DT fixes
2020-08-08 19:02:00 -05:00
Nick
c92f114efe
Add lighting behavior docs
2020-08-08 17:23:11 -05:00
Pete Johanson
e2848c66c3
Fix to archive the .hex files for proton-c build.
...
* Closes #77 .
2020-08-08 17:28:00 -04:00
Pete Johanson
483530e0ad
Basic key press/consumer press behavior docs.
2020-08-08 17:10:12 -04:00
Pete Johanson
85d35c7ff9
Tweak the pip PATH callouts.
2020-08-08 12:25:54 -04:00
Pete Johanson
5039a50831
Tweak git usage for backwards compatibility.
...
* Closes #76
2020-08-07 23:35:48 -04:00
Pete Johanson
b25133cbef
Add a layer diagram.
...
* Original diagram from Thomas Baart, used
with permission.
2020-08-07 16:45:11 -04:00
Pete Johanson
dd8deceed0
Add basic layer behavior docs.
2020-08-07 16:29:52 -04:00
Pete Johanson
3b841c65bb
Typo fix (thanks @Nicell).
2020-08-07 15:58:09 -04:00
Pete Johanson
4b310abb3d
Remove broken import.
2020-08-07 15:30:37 -04:00
Pete Johanson
5418918e13
Explicitly use bash.
2020-08-07 15:15:04 -04:00
Pete Johanson
14eef91da1
Better user setup docs.
2020-08-07 15:05:25 -04:00
Pete Johanson
afc1c38866
Merge pull request #75 from careyk007/main
...
Update dev-setup.md
2020-08-07 12:09:32 -04:00
Kellen Carey
5bfa4ba3ff
Update dev-setup.md
2020-08-07 08:58:07 -07:00
Pete Johanson
ccb9b9309a
Script fixes, ability to prepopulate a keymap.
...
* Use read w/ -i for initial default values.
* Prompt for fetching keymap for customization,
and grab latest from `main` if opted in.
* Don't copy `prj.conf` from the template,
pull the `<shield>.conf` from `main` also.
2020-08-07 10:02:44 -04:00
Pete Johanson
5c10517c29
Show the complete keymap example inline.
2020-08-07 09:36:48 -04:00
Pete Johanson
ec4c12501c
Fix up the keymap docs after the DT refactor.
2020-08-07 09:31:12 -04:00
Pete Johanson
10683fe1f8
Docs re-org, start of some keymap docs.
2020-08-06 15:04:31 -04:00
Pete Johanson
9233ab60cd
Minor fix for USB logging to work on peripherals.
2020-08-05 22:59:58 -04:00
Pete Johanson
6fd572d3b6
Use process.env.URL instead of DEPLOY_URL.
2020-08-05 14:58:25 -04:00
Pete Johanson
f71f12f5a8
Build fixes.
2020-08-05 14:51:31 -04:00
Pete Johanson
aa21bdd79a
Tweak for dynamic invite URL for deploys.
2020-08-05 14:43:59 -04:00
Pete Johanson
e1ea833bb3
Flesh out documentation skeleton.
2020-08-05 14:04:08 -04:00
Pete Johanson
db586b1ce0
Update to latest V2 Docusaurus.
2020-08-05 14:02:37 -04:00
Pete Johanson
761601be5b
Typo fix.
2020-08-04 14:19:32 -04:00
Pete Johanson
977259f906
Better wording on user setup intro.
2020-08-04 14:15:23 -04:00
Pete Johanson
fedd4381c2
Initial user setup docs, setup script fixes.
2020-08-04 14:12:10 -04:00
Pete Johanson
e9c2b84c82
Initial setup.sh version.
2020-08-04 13:41:07 -04:00
Pete Johanson
b7e1509413
Updated intro that better outlines features.
2020-08-03 23:48:17 -04:00
Pete Johanson
35c8b6b434
Improved hardware docs.
2020-08-03 23:44:53 -04:00
Pete Johanson
2d99e69eb7
Add Netlify deploy badge
2020-07-21 19:58:34 -04:00
Pete Johanson
22c0558b2f
Community link fixes.
2020-07-20 23:39:19 -04:00
Pete Johanson
c23c44a4c4
Fix the default OS tab.
2020-07-14 10:24:51 -04:00
Pete Johanson
8dcb03faa6
Tweaks for highlighting.
2020-07-14 06:40:53 -04:00
Pete Johanson
dd34edace1
Remaining fixes.
2020-07-14 00:12:54 -04:00
Pete Johanson
dca81c6579
Tweaks for multiple OS stuff.
2020-07-13 23:48:26 -04:00
Pete Johanson
092fa866af
Add doc on enabling USB logging.
2020-07-07 11:58:12 -04:00
Pete Johanson
4fb98e04f2
Add missing id header.
2020-07-07 10:54:28 -04:00
Pete Johanson
48f3f86a83
Initial shield dev guide.
2020-07-06 23:30:07 -04:00
Pete Johanson
bd1e2b069b
Expanded dev docs on boards/shields/keymaps.
2020-07-06 11:40:03 -04:00
Pete Johanson
3cc8b96ac8
Updated link to Discord invite.
2020-07-03 10:45:50 -04:00
Pete Johanson
87cd83ddb6
Move the netlify.toml file into docs/
2020-07-03 10:43:27 -04:00
Pete Johanson
22238d24de
Add Algolia search config.
2020-06-29 10:20:07 -04:00
Pete Johanson
c96e705e2e
A few more master to main fixes.
2020-06-17 10:38:15 -04:00
Pete Johanson
da5d5f988f
Fix links to docs from the FAQ.
2020-06-17 10:37:36 -04:00
Pete Johanson
766eedebe5
Move the gcc-multilib install to POSIX board doc.
2020-06-15 23:16:02 -04:00
Pete Johanson
c2e0c4fd6c
Fix some whitespace inconsistency.
2020-06-15 23:13:44 -04:00
Pete Johanson
789af69e52
Merge pull request #19 from petejohanson/docs/python-requirements-base-tweak
...
Only install `requirements-base.txt`
2020-06-14 23:22:03 -04:00
innovaker
82d0bd860d
docs: Add "sidebarCollapsible: false"
2020-06-14 14:23:48 +01:00
innovaker
a109de24b2
docs: faq: Replace all instances of "board" and "shield" with links [ #22 CR, #11 ]
2020-06-13 20:02:24 +01:00
innovaker
726b40cfa2
docs: faq: Add preface links to "Why boards and shields?" [ #22 CR, #11 ]
2020-06-13 20:02:24 +01:00
innovaker
c14beb7ee7
docs: Switch positions of 'hardware' and 'faq' on sidebars [ #22 CR, #11 ]
2020-06-13 19:54:55 +01:00
innovaker
30985517b8
docs: add faq to sidebars [ #11 ]
2020-06-13 18:47:20 +01:00
innovaker
70edcd4a3a
docs: initial version of faq.md [ #11 ]
2020-06-13 18:44:35 +01:00
Pete Johanson
4a39299db8
Only ask users to install requirements-base.txt.
2020-06-12 15:12:05 -04:00
innovaker
d11ade45d3
[ #16 ] Replaced 'Basics' with 'Getting Started'
2020-06-12 16:08:20 +01:00
Pete Johanson
16f9c4e715
Merge pull request #9 from Nicell/docs/update_docs_landing_page
...
Update landing page content and style
2020-06-10 23:11:35 -04:00
Nick
fa4519b596
Add missing button border definition
2020-06-10 22:07:21 -05:00
Nick
6af0f9f06e
Add missing border change
2020-06-10 22:03:52 -05:00
Nick
b7eeaeb941
Update landing page content and style
2020-06-10 21:58:31 -05:00
Pete Johanson
3d221053da
Initial code of conduct documentation.
2020-06-10 21:11:49 -04:00
Pete Johanson
b83b8c6a69
Merge pull request #4 from zmkfirmware/docs/better-dev-setup-instructions
...
Improved dev setup docs.
2020-06-10 21:00:27 -04:00
Pete Johanson
8a81dbb5fb
Split apt update and install into two sections.
2020-06-10 20:58:32 -04:00
Pete Johanson
86da8f8875
Remove note about wb55rg USB issues, consumer keys
2020-06-10 19:04:32 -04:00
Pete Johanson
8527102bb9
Add a note about older Ubuntu LTS and CMake.
2020-06-10 11:23:42 -04:00
Pete Johanson
20545ea4fa
Add note about possible missing west command.
2020-06-10 11:18:22 -04:00
Pete Johanson
43008494c4
Header level fix.
2020-06-10 11:07:20 -04:00
Pete Johanson
6ef823be3a
More doc tweaks for SDK install and build clarity.
...
* Suggest installing SDK to `~/.local` directory.
* Clarify about switching to `app/` before build/flash.
2020-06-10 11:00:03 -04:00
Pete Johanson
2f4bc94b7e
Tweaks to sourcing the zephyr-env.sh script.
2020-06-10 10:31:21 -04:00
Pete Johanson
9e62cc7069
Fix a .zephyrrc typo.
2020-06-10 10:30:28 -04:00
Pete Johanson
35d07cff17
Apply suggestions from code review
...
Co-authored-by: Nick Winans <nick@winans.codes>
2020-06-10 10:06:55 -04:00
Pete Johanson
2c63214c7d
A few more missing build steps.
2020-06-10 00:13:55 -04:00
Pete Johanson
5cebba1637
Various docs fixes, including PR feedback.
2020-06-10 00:05:28 -04:00
Pete Johanson
a952cd6899
Title fix, remove redundant "keyboard".
2020-06-09 23:24:19 -04:00
Pete Johanson
e9d7c54b1c
New logo and color palette.
2020-06-09 23:18:12 -04:00
Pete Johanson
a709e95680
Fill out dev setup even more.
2020-06-09 23:15:02 -04:00
Pete Johanson
4ea641f34a
Typo fix, add ™ properly.
2020-06-09 17:00:22 -04:00
Pete Johanson
7cb7d705d6
Improved dev setup docs.
2020-06-09 16:35:47 -04:00
Pete Johanson
1ba66e7dbe
Nix Bluetooth in favor of BLE for now.
2020-06-09 15:50:46 -04:00
Pete Johanson
dbabeffa8a
Properly reference MIT license consistently.
2020-06-09 09:52:26 -04:00
Pete Johanson
6b48b6dadd
Initial cleanup of docs template, GitHub URLs, etc.
2020-06-08 23:10:48 -04:00
Pete Johanson
c1cc46c3b2
Updated favicon for the docs site.
2020-06-08 11:07:08 -04:00
Pete Johanson
5304ff9c77
Basic ZMK logo.
2020-06-08 10:46:38 -04:00
Pete Johanson
84dcf3715f
Typo fix for the intro page.
2020-06-08 10:41:02 -04:00
Pete Johanson
f1afbb8e49
Some basic docs clean up.
2020-05-31 15:35:32 -04:00
Pete Johanson
749df61a2e
Add docs about clean room design.
2020-05-31 10:54:14 -04:00
Pete Johanson
dfd5bc0586
More complete intro to the project.
2020-05-26 11:55:58 -04:00
Pete Johanson
e00408d746
Initial work on basic documentation.
2020-05-25 21:33:21 -04:00
