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
5c10517c29
Show the complete keymap example inline.
2020-08-07 09:36:48 -04:00
ec4c12501c
Fix up the keymap docs after the DT refactor.
2020-08-07 09:31:12 -04:00
10683fe1f8
Docs re-org, start of some keymap docs.
2020-08-06 15:04:31 -04:00
9233ab60cd
Minor fix for USB logging to work on peripherals.
2020-08-05 22:59:58 -04:00
6fd572d3b6
Use `process.env.URL` instead of `DEPLOY_URL`.
2020-08-05 14:58:25 -04:00
f71f12f5a8
Build fixes.
2020-08-05 14:51:31 -04:00
aa21bdd79a
Tweak for dynamic invite URL for deploys.
2020-08-05 14:43:59 -04:00
e1ea833bb3
Flesh out documentation skeleton.
2020-08-05 14:04:08 -04:00
db586b1ce0
Update to latest V2 Docusaurus.
2020-08-05 14:02:37 -04:00
761601be5b
Typo fix.
2020-08-04 14:19:32 -04:00
977259f906
Better wording on user setup intro.
2020-08-04 14:15:23 -04:00
fedd4381c2
Initial user setup docs, setup script fixes.
2020-08-04 14:12:10 -04:00
e9c2b84c82
Initial setup.sh version.
2020-08-04 13:41:07 -04:00
b7e1509413
Updated intro that better outlines features.
2020-08-03 23:48:17 -04:00
35c8b6b434
Improved hardware docs.
2020-08-03 23:44:53 -04:00
2d99e69eb7
Add Netlify deploy badge
2020-07-21 19:58:34 -04:00
22c0558b2f
Community link fixes.
2020-07-20 23:39:19 -04:00
c23c44a4c4
Fix the default OS tab.
2020-07-14 10:24:51 -04:00
8dcb03faa6
Tweaks for highlighting.
2020-07-14 06:40:53 -04:00
dd34edace1
Remaining fixes.
2020-07-14 00:12:54 -04:00
dca81c6579
Tweaks for multiple OS stuff.
2020-07-13 23:48:26 -04:00
092fa866af
Add doc on enabling USB logging.
2020-07-07 11:58:12 -04:00
4fb98e04f2
Add missing `id` header.
2020-07-07 10:54:28 -04:00
48f3f86a83
Initial shield dev guide.
2020-07-06 23:30:07 -04:00
bd1e2b069b
Expanded dev docs on boards/shields/keymaps.
2020-07-06 11:40:03 -04:00
3cc8b96ac8
Updated link to Discord invite.
2020-07-03 10:45:50 -04:00
87cd83ddb6
Move the netlify.toml file into docs/
2020-07-03 10:43:27 -04:00
22238d24de
Add Algolia search config.
2020-06-29 10:20:07 -04:00
c96e705e2e
A few more master to main fixes.
2020-06-17 10:38:15 -04:00
da5d5f988f
Fix links to docs from the FAQ.
2020-06-17 10:37:36 -04:00
766eedebe5
Move the gcc-multilib install to POSIX board doc.
2020-06-15 23:16:02 -04:00
c2e0c4fd6c
Fix some whitespace inconsistency.
2020-06-15 23:13:44 -04:00
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
82d0bd860d
docs: Add "sidebarCollapsible: false"
2020-06-14 14:23:48 +01:00
a109de24b2
docs: faq: Replace all instances of "board" and "shield" with links [ #22 CR, #11 ]
2020-06-13 20:02:24 +01:00
726b40cfa2
docs: faq: Add preface links to "Why boards and shields?" [ #22 CR, #11 ]
2020-06-13 20:02:24 +01:00
c14beb7ee7
docs: Switch positions of 'hardware' and 'faq' on sidebars [ #22 CR, #11 ]
2020-06-13 19:54:55 +01:00
30985517b8
docs: add faq to sidebars [ #11 ]
2020-06-13 18:47:20 +01:00
70edcd4a3a
docs: initial version of faq.md [ #11 ]
2020-06-13 18:44:35 +01:00
4a39299db8
Only ask users to install requirements-base.txt.
2020-06-12 15:12:05 -04:00
d11ade45d3
[ #16 ] Replaced 'Basics' with 'Getting Started'
2020-06-12 16:08:20 +01:00
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
fa4519b596
Add missing button border definition
2020-06-10 22:07:21 -05:00
6af0f9f06e
Add missing border change
2020-06-10 22:03:52 -05:00
b7eeaeb941
Update landing page content and style
2020-06-10 21:58:31 -05:00
3d221053da
Initial code of conduct documentation.
2020-06-10 21:11:49 -04:00
b83b8c6a69
Merge pull request #4 from zmkfirmware/docs/better-dev-setup-instructions
...
Improved dev setup docs.
2020-06-10 21:00:27 -04:00
8a81dbb5fb
Split apt update and install into two sections.
2020-06-10 20:58:32 -04:00
86da8f8875
Remove note about wb55rg USB issues, consumer keys
2020-06-10 19:04:32 -04:00
8527102bb9
Add a note about older Ubuntu LTS and CMake.
2020-06-10 11:23:42 -04:00
20545ea4fa
Add note about possible missing `west` command.
2020-06-10 11:18:22 -04:00
43008494c4
Header level fix.
2020-06-10 11:07:20 -04:00
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
2f4bc94b7e
Tweaks to sourcing the `zephyr-env.sh` script.
2020-06-10 10:31:21 -04:00
9e62cc7069
Fix a `.zephyrrc` typo.
2020-06-10 10:30:28 -04:00
35d07cff17
Apply suggestions from code review
...
Co-authored-by: Nick Winans <nick@winans.codes>
2020-06-10 10:06:55 -04:00
2c63214c7d
A few more missing build steps.
2020-06-10 00:13:55 -04:00
5cebba1637
Various docs fixes, including PR feedback.
2020-06-10 00:05:28 -04:00
a952cd6899
Title fix, remove redundant "keyboard".
2020-06-09 23:24:19 -04:00
e9d7c54b1c
New logo and color palette.
2020-06-09 23:18:12 -04:00
a709e95680
Fill out dev setup even more.
2020-06-09 23:15:02 -04:00
4ea641f34a
Typo fix, add ™ properly.
2020-06-09 17:00:22 -04:00
7cb7d705d6
Improved dev setup docs.
2020-06-09 16:35:47 -04:00
1ba66e7dbe
Nix Bluetooth in favor of BLE for now.
2020-06-09 15:50:46 -04:00
dbabeffa8a
Properly reference MIT license consistently.
2020-06-09 09:52:26 -04:00
6b48b6dadd
Initial cleanup of docs template, GitHub URLs, etc.
2020-06-08 23:10:48 -04:00
c1cc46c3b2
Updated favicon for the docs site.
2020-06-08 11:07:08 -04:00
5304ff9c77
Basic ZMK logo.
2020-06-08 10:46:38 -04:00
84dcf3715f
Typo fix for the intro page.
2020-06-08 10:41:02 -04:00
f1afbb8e49
Some basic docs clean up.
2020-05-31 15:35:32 -04:00
749df61a2e
Add docs about clean room design.
2020-05-31 10:54:14 -04:00
dfd5bc0586
More complete intro to the project.
2020-05-26 11:55:58 -04:00
e00408d746
Initial work on basic documentation.
2020-05-25 21:33:21 -04:00
Pete Johanson
innovaker
Nick