From ee180b7fc5d2beb18c4ce16aadeb64c4f782ea9b Mon Sep 17 00:00:00 2001 From: Karl Grasegger Date: Wed, 2 Aug 2023 19:59:09 +0200 Subject: [PATCH] Clean up english documentation to replace 'here' with more meaningfull descriptions (#713) --- docs/en/Getting_Started.md | 2 +- docs/en/Officially_Supported_Microcontrollers.md | 9 +++------ docs/en/boot.md | 2 +- docs/en/handwiring.md | 2 +- 4 files changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/en/Getting_Started.md b/docs/en/Getting_Started.md index cbe72fa31..aa1197157 100644 --- a/docs/en/Getting_Started.md +++ b/docs/en/Getting_Started.md @@ -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)! diff --git a/docs/en/Officially_Supported_Microcontrollers.md b/docs/en/Officially_Supported_Microcontrollers.md index c7fbd8869..f7c97a101 100644 --- a/docs/en/Officially_Supported_Microcontrollers.md +++ b/docs/en/Officially_Supported_Microcontrollers.md @@ -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) @@ -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) diff --git a/docs/en/boot.md b/docs/en/boot.md index a7cad0fa0..97bee4a17 100644 --- a/docs/en/boot.md +++ b/docs/en/boot.md @@ -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 diff --git a/docs/en/handwiring.md b/docs/en/handwiring.md index 2b4e9a98e..3b22d8e25 100644 --- a/docs/en/handwiring.md +++ b/docs/en/handwiring.md @@ -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)