Commit Graph

59 Commits (2ad2b73d685cf25268fa7d3726f45594edee70c4)

Author SHA1 Message Date
Drashna Jaelre 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494)
* Add support document

* Add Bug Report

* Add GitHub Pull Request Template

* Feature request issue template

* Touch up feature request template

* Add 'other issues' template

* move support doc

* Minor tweaks

* More minor tweaks

* Spleeling fix

Co-Authored-By: drashna <drashna@live.com>

* CapiTALization fIXes

Co-Authored-By: drashna <drashna@live.com>

* Use new issue URL

Co-Authored-By: drashna <drashna@live.com>

* Add blanck issue template

* Update the PR template

* Formatting and additional changes

* Update docs/support.md

Co-Authored-By: drashna <drashna@live.com>
6 years ago
Drashna Jaelre 59b2be6200 Re-order feature list in sidebar (#4555)
Specifically, moved the shifted keycodes to the top of the 'Feature' list, so it's more visible.  This way, all of the keycodes are at the top of the list, rather than having the shifted keys at the bottom, so they should be easier to find since they're all in one place.
6 years ago
noroadsleft d8f090e559 Docs: Supporting a keyboard in the QMK Configurator (#4396)
* Docs: Configurator Support

* Minor updates

* Updated keyboard.h example to use #pragma once

per @drashna
https://github.com/qmk/qmk_firmware/pull/4396#discussion_r232140934

* Add link to doc under Reference section

Added to _sidebar.md and _summary.md

* Changed doc title; minor tweaks

Re-titled the doc as "Supporting Your Keyboard in QMK Configurator".
Made some minor changes to the keyboard.h examples.

* Added tags object to JSON example
7 years ago
yiancar 4083614023 I2C driver docs (#4298)
* I2C driver docs

- Added I2C driver docs.
- Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world.

* Update docs/i2c_driver.md

Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy>

* Update docs/i2c_driver.md

Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy>

* Update docs/i2c_driver.md

Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy>

* Update docs/i2c_driver.md

Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy>

* GPIO release fix
7 years ago
Jack Humbert 85688e5b52 add support for encoders to core 7 years ago
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
7 years ago
Drashna Jaelre a7d05820a6 Add documentation for Combo feature 7 years ago
yiancar ac7b2d92bf ARM SWD guide
- Added a detailed (but saddly long) debugging guide.
- Modified sidebar and summary to include the links.
7 years ago
Drashna Jaelre eb19fb5b57 Helpful functions 7 years ago
skullY da24a34efb First pass at reorganizing docs 7 years ago
fauxpark d263b27c9a Dedupe shifted keycodes listing 7 years ago
fauxpark 03ad6927cb Docs: Format Space Cadet documentation (#3540)
* Format Space Cadet documentation

* Fix page filenames

* Move Caveats section up
7 years ago
Drashna Jaelre e0c9cfad86 Fix sidebard doc 7 years ago
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
7 years ago
Jack Humbert ae7284edb8 rename api docs to internals 7 years ago
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
7 years ago
skullydazed 566399794a
Disable the glossary linking to fix #2498 (#2499) 7 years ago
Joe Wasson 7b80aea8b2 Add back docs for hand-swapping feature. 7 years ago
skullydazed 08e48eb6f5
Add a newbie guide for people completely new to QMK (#2480) 7 years ago
skullydazed e87c39d302
More thoroughly document Bootmagic and Command (#2455) 7 years ago
fauxpark 7b0356d1d4 Convert all headings to Title Case 7 years ago
Balz Guenat 8b1862330a fix link for grave escape in docs 7 years ago
skullY 0b54e7f5ae Flesh out the grave escape overrides 8 years ago
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.
8 years ago
skullY 66f13e4972 Move keycodes to their own section 8 years ago
Jack Humbert 38261920a9
update hand wiring link 8 years ago
Jeremy Cowgar bf1fedc05e Fixed various feature links 8 years ago
Jack Humbert 4d421ee31c adds flashing docs 8 years ago
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
8 years ago
Jack Humbert 06f196c589 Creates a userspace for keymaps (#1559)
* create a user space

* adds example

* document, add readme.md

* jackhumbert userspace, ergodox keymap
8 years ago
skullY db5afb05cf Fix the presentation of the contribution guide 8 years ago
skullydazed 2db4ad2133 Write a contributing guide. (#1827) 8 years ago
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
8 years ago
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
8 years ago
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
8 years ago
Jack Humbert 52f2f6d8ea adds audio docs to summary 8 years ago
skullY 9d1a08e38a Doc updates from going through every file 8 years ago
skullY 9b879b1267 break up keymaps and quantum keycodes into files by feature 8 years ago
skullY 207bcd788a rework key_functions into feature_common_shortcuts 8 years ago
skullY e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 years ago
Fredric Silberberg 5fc4a664dc Added initial key lock documentation. 8 years ago
Joe Wasson 26fb063be3 Link to steno docs from summary page. 8 years ago
Jack Humbert 14c5160b1a Update _summary.md 8 years ago
skullY 9cadba7b89 Add missing files to _summary.md 8 years ago
skullY c12f19107f update the summary 8 years ago
skullY d8e29b53fe Update a bunch of docs 8 years ago
Jack Humbert 3e3c3e2b24 start glossary 8 years ago
Jack Humbert 4c7e66c31c add file to summary 8 years ago
skullY 409cb1af52 Polish up custom_quantum_functions 8 years ago
Jack Humbert b75ad215c8 use default base names 8 years ago