ae7284edb8
rename api docs to internals
7 years ago
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
7 years ago
566399794a
Disable the glossary linking to fix #2498 ( #2499 )
7 years ago
7b80aea8b2
Add back docs for hand-swapping feature.
7 years ago
08e48eb6f5
Add a newbie guide for people completely new to QMK ( #2480 )
7 years ago
e87c39d302
More thoroughly document Bootmagic and Command ( #2455 )
7 years ago
7b0356d1d4
Convert all headings to Title Case
7 years ago
8b1862330a
fix link for grave escape in docs
7 years ago
0b54e7f5ae
Flesh out the grave escape overrides
7 years ago
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.
7 years ago
66f13e4972
Move keycodes to their own section
7 years ago
38261920a9
update hand wiring link
7 years ago
bf1fedc05e
Fixed various feature links
7 years ago
4d421ee31c
adds flashing docs
7 years ago
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
7 years ago
06f196c589
Creates a userspace for keymaps ( #1559 )
...
* create a user space
* adds example
* document, add readme.md
* jackhumbert userspace, ergodox keymap
7 years ago
db5afb05cf
Fix the presentation of the contribution guide
7 years ago
2db4ad2133
Write a contributing guide. ( #1827 )
7 years ago
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
7 years ago
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
7 years ago
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
7 years ago
52f2f6d8ea
adds audio docs to summary
7 years ago
9d1a08e38a
Doc updates from going through every file
7 years ago
9b879b1267
break up keymaps and quantum keycodes into files by feature
7 years ago
207bcd788a
rework key_functions into feature_common_shortcuts
7 years ago
e6c638bed1
Overhaul the Getting Started section and add a FAQ section
7 years ago
5fc4a664dc
Added initial key lock documentation.
7 years ago
26fb063be3
Link to steno docs from summary page.
7 years ago
14c5160b1a
Update _summary.md
7 years ago
9cadba7b89
Add missing files to _summary.md
7 years ago
c12f19107f
update the summary
7 years ago
d8e29b53fe
Update a bunch of docs
7 years ago
3e3c3e2b24
start glossary
7 years ago
4c7e66c31c
add file to summary
7 years ago
409cb1af52
Polish up custom_quantum_functions
7 years ago
b75ad215c8
use default base names
7 years ago
391eae97e4
testing out new home
7 years ago
d59734d3b7
restructure summary
7 years ago
d5244c6cf4
restructure keycode docs
7 years ago
40d82906cb
adds config options md
7 years ago
4ba9438c3f
Add eclipse to the _summary
7 years ago
901a92a2fd
Update _summary.md
8 years ago
918aea5b47
Update _summary.md
8 years ago
2b98ec67f3
Update _summary.md
8 years ago
995c3141a6
convert docs to lowercase and underscores
8 years ago
Jack Humbert