noroadsleft
480651cf9d
Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc ( #3902 )
...
* Docs: newbs_learn_more_resources.md: formatting
* Added QMK Git Conventions doc, initial version
* Renamed contributing_qmk.md to newbs_best_practices.md
* Updated per review by @drashna
* Added navigation links
* Updated to Best Practices doc
* Minor updates to Learn More Resources doc
Markdown formatting consistency because I'm particular about it.
* Added Merge Conflict section to Best Practices doc
2018-10-18 15:12:11 -07:00
Drashna Jaelre
a7d05820a6
Add documentation for Combo feature
2018-10-10 21:36:58 -04:00
yiancar
ac7b2d92bf
ARM SWD guide
...
- Added a detailed (but saddly long) debugging guide.
- Modified sidebar and summary to include the links.
2018-10-05 11:03:30 -07:00
Drashna Jaelre
eb19fb5b57
Helpful functions
2018-08-26 07:32:15 -07:00
skullY
da24a34efb
First pass at reorganizing docs
2018-08-16 09:16:05 -07:00
fauxpark
d263b27c9a
Dedupe shifted keycodes listing
2018-08-11 14:29:53 -07:00
fauxpark
03ad6927cb
Docs: Format Space Cadet documentation ( #3540 )
...
* Format Space Cadet documentation
* Fix page filenames
* Move Caveats section up
2018-08-01 08:43:54 -07:00
Drashna Jaelre
e0c9cfad86
Fix sidebard doc
2018-07-16 21:04:12 -04:00
Drashna Jaelre
8ffeaec3aa
Overhaul to keycode related docs
...
* Adds Audio Keycodes to both the feature page and master list
* Re-orders the keycode list, so it's alphabetical (mostly)
* Add additional (missing) sections to the keycode list
* Add and update links in the keycode page
* Add and reorder links in sidebar's keycode section
2018-07-15 13:40:18 -04:00
Jack Humbert
ae7284edb8
rename api docs to internals
2018-03-26 11:43:37 -07:00
skullydazed
7c9d5ace14
Generate API docs from source code comments ( #2491 )
...
* Generate api docs from source code
* Add a bunch of doxygen comments
* more doxygen comments
* Add the in-progress api docs
* script to generate docs from travis
* Add doc generation to the travis job
* make travis_docs.sh commit the work it does
* make sure the docs script exits cleanly
2018-03-22 02:50:38 -04:00
skullydazed
566399794a
Disable the glossary linking to fix #2498 ( #2499 )
2018-03-08 10:31:08 -08:00
Joe Wasson
7b80aea8b2
Add back docs for hand-swapping feature.
2018-03-07 16:56:57 -05:00
skullydazed
08e48eb6f5
Add a newbie guide for people completely new to QMK ( #2480 )
2018-03-06 14:37:48 -08:00
skullydazed
e87c39d302
More thoroughly document Bootmagic and Command ( #2455 )
2018-03-02 09:21:03 -08:00
fauxpark
7b0356d1d4
Convert all headings to Title Case
2017-12-09 10:46:11 -05:00
Balz Guenat
8b1862330a
fix link for grave escape in docs
2017-12-08 16:12:46 -05:00
skullY
0b54e7f5ae
Flesh out the grave escape overrides
2017-12-03 00:00:23 -05:00
Devin J. Pohly
7aaef16266
Fix internal links in docs/ ( #2080 )
...
One link in the summary (Modding your keyboard) referred to a page that
was deleted; the rest have been updated to point to the new names.
2017-11-30 10:18:01 -08:00
skullY
66f13e4972
Move keycodes to their own section
2017-11-10 17:58:32 -05:00
Jack Humbert
38261920a9
update hand wiring link
2017-10-31 13:38:57 -04:00
Jeremy Cowgar
bf1fedc05e
Fixed various feature links
2017-10-29 20:04:10 -04:00
Jack Humbert
4d421ee31c
adds flashing docs
2017-10-29 18:44:29 -04:00
skullydazed
67cc5cebc0
Restructure the hardware and feature docs to make things easier to find ( #1888 )
...
* fix #1313 by documenting more config.h options
* Clean up and organize documentation
2017-10-24 20:34:28 -07:00
Jack Humbert
06f196c589
Creates a userspace for keymaps ( #1559 )
...
* create a user space
* adds example
* document, add readme.md
* jackhumbert userspace, ergodox keymap
2017-10-21 11:44:11 -10:00
skullY
db5afb05cf
Fix the presentation of the contribution guide
2017-10-11 12:18:53 -07:00
skullydazed
2db4ad2133
Write a contributing guide. ( #1827 )
2017-10-11 12:07:15 -07:00
Snipeye
cfd118d158
Added Dichotemy Keyboard, updated docs for Pointing Device ( #1817 )
...
* Added Dichotemy Keyboard, updated docs for Pointing Device
* Updated readme
* Updated mouse report pointer in pointing_device.c
2017-10-10 07:07:59 -10:00
Jack Humbert
7ad924bae5
Updates send_string functionality, adds terminal feature ( #1657 )
...
* implement basic terminal stuff
* modify send_string to read normal strings too
* add files bc yeah. working pgm detected
* pgm detection apparently not working
* adds send string keycodes, additional keycode support in send string
* implement arguments
* [terminal] add help command
* [terminal] adds keycode and keymap functions
* [terminal] adds nop.h, documentation
* update macro docs
2017-09-12 00:43:10 -04:00
Jack Humbert
d2ff66a985
Creates a layouts/ folder for keymaps shared between keyboards ( #1609 )
...
* include variables and .h files as pp directives
* start layout compilation
* split ergodoxes up
* don't compile all layouts for everything
* might seg fault
* reset layouts variable
* actually reset layouts
* include rules.mk instead
* remove includes from rules.mk
* update variable setting
* load visualizer from path
* adds some more examples
* adds more layouts
* more boards added
* more boards added
* adds documentation for layouts
* use lowercase names for LAYOUT_
* add layout.json files for each layout
* add community folder, default keymaps for layouts
* touch-up default layouts
* touch-up layouts, some keyboard rules.mk
* update documentation for layouts
* fix up serial/i2c switches
2017-08-23 22:29:07 -04:00
Jack Humbert
52f2f6d8ea
adds audio docs to summary
2017-08-18 13:57:57 -04:00
skullY
9d1a08e38a
Doc updates from going through every file
2017-08-16 15:47:20 -04:00
skullY
9b879b1267
break up keymaps and quantum keycodes into files by feature
2017-08-16 15:47:20 -04:00
skullY
207bcd788a
rework key_functions into feature_common_shortcuts
2017-08-16 15:47:20 -04:00
skullY
e6c638bed1
Overhaul the Getting Started section and add a FAQ section
2017-08-16 15:47:20 -04:00
Fredric Silberberg
5fc4a664dc
Added initial key lock documentation.
2017-08-08 10:02:53 -04:00
Joe Wasson
26fb063be3
Link to steno docs from summary page.
2017-07-27 16:10:36 -04:00
Jack Humbert
14c5160b1a
Update _summary.md
2017-07-17 15:01:33 -04:00
skullY
9cadba7b89
Add missing files to _summary.md
2017-07-03 12:39:15 -07:00
skullY
c12f19107f
update the summary
2017-07-03 12:30:26 -07:00
skullY
d8e29b53fe
Update a bunch of docs
2017-07-03 01:30:36 -07:00
Jack Humbert
3e3c3e2b24
start glossary
2017-06-29 22:12:24 -04:00
Jack Humbert
4c7e66c31c
add file to summary
2017-06-29 19:37:49 -04:00
skullY
409cb1af52
Polish up custom_quantum_functions
2017-06-29 10:46:23 -07:00
Jack Humbert
b75ad215c8
use default base names
2017-06-29 12:25:29 -04:00
Jack Humbert
391eae97e4
testing out new home
2017-06-29 12:13:44 -04:00
Jack Humbert
d59734d3b7
restructure summary
2017-06-29 10:35:09 -04:00
Jack Humbert
d5244c6cf4
restructure keycode docs
2017-06-29 00:15:07 -04:00
Jack Humbert
40d82906cb
adds config options md
2017-06-28 21:20:23 -04:00
Jack Humbert
4ba9438c3f
Add eclipse to the _summary
2017-06-27 13:07:50 -04:00
