Joel Challis
39324e642f
Update Discord URL ( #24283 )
2024-08-15 14:37:27 +01:00
Joel Challis
b39285807e
[docs] Fix code blocks overflowing page width ( #23829 )
...
Fix code blocks overflowing page width
2024-05-30 10:00:28 +01:00
Nick Brassel
6ef9717288
Vitepress conversion of docs. ( #23795 )
2024-05-30 12:00:41 +10:00
Tom Barnes
f35cb924e9
Update newbs docs with some rp2040 stuff ( #21186 )
...
* Update newbs_building_firmware_configurator.md
* Update docs/newbs_flashing.md
Co-authored-by: Ryan <fauxpark@gmail.com>
2023-06-10 15:56:43 +01:00
ripdog
4e35697e1a
Add note about qmk doctor in newbs_flashing.md ( #15688 )
...
Co-authored-by: Drashna Jaelre <drashna@live.com>
2022-07-02 22:48:44 +10:00
adlainewson
069ef7eb9e
[Docs] newbs_flashing.md: add link to build environment section ( #15654 )
2022-01-10 16:54:22 -08:00
Arthur Tabatchnic
0f516d9026
A few small typo fixes in docs ( #12524 )
2021-04-11 12:50:45 +02:00
Joel Challis
4e8166750b
Small tweaks to docs to make them more user friendly ( #11518 )
...
* first pass
* firmware firmware?
* Split out debug + testing docs
* tidy up duplicate css
* Add extra info to debug example
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-01-20 18:46:01 +00:00
Ryan
9c8f61dfa0
[Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro ( #9077 )
...
* newbs_flashing.md: place bootloader instructions before Toolbox intro
* Update docs/newbs_flashing.md
* More wordsmithing, point ARM users at Discord if all else fails
* Link Discord
2020-05-21 09:24:39 -07:00
skullY
54c58ea6de
Add explicit id tags to externally linked headers
2020-03-05 16:00:10 -08:00
skullY
45e218ceec
overhaul the newbs guide
2020-03-05 16:00:10 -08:00
skullY
a701c15d87
Rework the newbs guide around the qmk cli
2020-03-05 16:00:10 -08:00
Drashna Jaelre
0e6f78547e
[Docs] Update flashing information to include :flash target ( #6999 )
...
* Update Newbs Flashing guide
For the newbs that want to start flashing
* Update flashing docs
* Misc flashing
* Attempt at flashing in french
Lets hope I didn't butcher this too badly with machine transations
* Update docs/feature_userspace.md
* Apply language suggestions from code review
* Apply suggestions from code review
* Apply additional fr lang suggestions from code review
* Apply suggestions from code review
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch>
Co-Authored-By: Xavier Hahn <xavier.hahn@gmail.com>
Co-Authored-By: Vincent LE GOFF <vince.legoff@gmail.com>
2019-10-29 13:15:03 -07:00
Max Rumpf
1c07d4e7ef
[Docs] Clean up docs/newbs_flashing.md ( #6973 )
...
* [Docs] Clean up docs/newbs_flashing.md
See #6930
* Fix typo
2019-10-08 21:55:44 -07:00
Erik Doffagne
de386e5972
Fixed typos in documentation ( #6871 )
...
* Fixed typos in documentation
* Update docs/arm_debugging.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/arm_debugging.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-10-02 16:41:32 -04:00
Joel Challis
17794e0b25
ARM split - Add support for dfu-util EE_HANDS flashing ( #6543 )
...
* Initial stab at some fake dfu-util-split-left behaviour
* Apply suggestions from code review
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Clang format fixes
* Fake eeprom init for both left and right hand
2019-09-27 21:33:55 +01:00
Joel Challis
51bcadf38c
Add 'bootloadHID' flash target ( #5587 )
...
* Add 'bootloadHID' flash target
* Prep for flash target
* Add :flash support
* Align bootloader wait messages
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* Update template to suggest use of :flash
2019-08-24 08:35:11 -07:00
Rasmus Lindroth
2f3807682d
Fix typo for building Ergodox EZ keyboards ( #6453 )
2019-07-31 06:08:25 -07:00
Phil Schalm
663ca6ba9d
Documentation: Newbs Flashing: Hightlight that sudo may be needed ( #6300 )
...
* Hightlight that sudo may be needed
Also added "dfu-programmer: no device present" in so that anyone searching for that particular error can hopefully find the page.
* Use new style of indicating a warning
* Indicate that the FAQ should be read instead of blindly using sudo
2019-07-12 05:42:21 -07:00
Drashna Jaelre
c534a4c775
[Docs] Smallish overhaul of the docs ( #5281 )
...
* Fix up Common functions doc
* Add to extra commands to flashing doc
* Rearrange and touch up Macros
* Expand Newbs Flashing guide
* Update process_record documentation
* Add git to best practices name in sidebar
* Expand FAQ for build/flashing
* Add deprecated info to functions
* Update docs/feature_macros.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/feature_macros.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/keymap.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/newbs_flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/newbs_flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/faq_build.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/feature_macros.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/keymap.md
Co-Authored-By: drashna <drashna@live.com>
* Fix up Common functions doc
* Make pre-init example accurate
* Update docs/custom_quantum_functions.md
Co-Authored-By: drashna <drashna@live.com>
* Zadig Driver catchall
* Spelling Depriciated
* Completely remove fn_actions section
2019-03-18 14:22:02 -07:00
noroadsleft
9c73a4a5c6
Grammar cleanup of Flashing Your Keyboard Newbs Guide ( #5201 )
...
Fixed references to a "built" (sic) command, and an incorrect word.
2019-02-21 09:24:59 -08:00
skullY
303f425c6b
Fix up info boxes.
2018-05-07 22:46:26 -07:00
Drashna Jaelre
ee1bb85542
Expand Newb Guide flashing document ( #2588 )
...
* Add header info
* Add DFU section
* Add Caterina section
* Add Halfkay section
* Fix Typos
* More typos
2018-03-26 13:34:18 -04:00
skullydazed
08e48eb6f5
Add a newbie guide for people completely new to QMK ( #2480 )
2018-03-06 14:37:48 -08:00
