Skip to content

Commit

Permalink
Clean up english documentation to replace 'here' with more meaningful…
Browse files Browse the repository at this point in the history
…l descriptions (#713)
  • Loading branch information
Karl Grasegger committed Aug 3, 2023
1 parent 5e3274c commit ee180b7
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/en/Getting_Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ You can also get ideas from the various [user examples](https://github.com/KMKfw
## Additional help and support
> Roads? Where we're going we don't need roads.
In case you need it, debugging help can be found [here](debugging.md)
In case you need it, debugging help can be found on the [debugging](debugging.md) page.

For asynchronous support and chatter about KMK, [join our Zulip
community](https://kmkfw.zulipchat.com)!
Expand Down
9 changes: 3 additions & 6 deletions docs/en/Officially_Supported_Microcontrollers.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ Features include
- Can run most features of KMK including RGB

Downsides
- Needs adapted to work with Pro Micro pinout keyboards. Adapter can be found
[HERE](https://github.com/KMKfw/kmk_firmware/tree/master/hardware)
- Needs to be adapted to work with Pro Micro pinout keyboards. You can find a tutorial and files for such an adapter [in our github repo under /hardware](https://github.com/KMKfw/kmk_firmware/tree/master/hardware)

Common Retailers
- [Adafruit](https://www.adafruit.com/product/3800)
Expand All @@ -52,10 +51,8 @@ Features include
- More affordable than the nice!nano at only $18

Downsides
- Needs adapted to work with Pro Micro pinout keyboards. Adapter can be found
[HERE](https://github.com/KMKfw/kmk_firmware/tree/master/hardware)
- No battery support without addon board found
[HERE](https://www.adafruit.com/product/2124)
- Needs to be adapted to work with Pro Micro pinout keyboards. You can find a tutorial and files for such an adapter [in our github repo under /hardware](https://github.com/KMKfw/kmk_firmware/tree/master/hardware)
- No battery support without addon board like [this one by adafruit](https://www.adafruit.com/product/2124)

Common Retailers
- [Adafruit](https://www.adafruit.com/product/4481)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/boot.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# boot.py
`boot.py` lives in the root of your keyboard when mounted as a storage device.
There is a more detailed explanation in the [circuit python docs](https://docs.circuitpython.org/en/latest/README.html),
however there are some common use cases for your keyboard listed here.
however there are some common use cases for your keyboard listed on this page.


## KMKs builtin boot configurator
Expand Down
2 changes: 1 addition & 1 deletion docs/en/handwiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ This guide will not talk about the physical wiring. Check out our
[recommended microcontrollers](Officially_Supported_Microcontrollers.md) and
follow this amazing [hand wiring guide](https://docs.qmk.fm/#/hand_wire). That
guide can be followed until you are setting up the firmware. After wiring the
keyboard, you can refer to our porting guide [here](porting_to_kmk.md)
keyboard, you can refer to our [porting guide](porting_to_kmk.md)

0 comments on commit ee180b7

Please sign in to comment.