From 8d0cda7c5a43c84dd18b927cb73672158e4f8abc Mon Sep 17 00:00:00 2001 From: Phong Le <105464424+Vanphongle@users.noreply.github.com> Date: Fri, 24 Feb 2023 22:54:37 -0500 Subject: [PATCH] Update links --- docs/en/Getting_Started.md | 8 ++++---- docs/en/ble_hid.md | 4 ++-- docs/en/contributing.md | 2 +- docs/en/flashing.md | 5 ++--- docs/en/handwiring.md | 2 +- docs/en/kmkpython_vs_circuitpython.md | 2 +- docs/en/peg_oled_display.md | 2 +- docs/en/peg_rgb_matrix.md | 2 +- docs/en/porting_to_kmk.md | 2 +- 9 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/en/Getting_Started.md b/docs/en/Getting_Started.md index 46a8658..1d5c80e 100644 --- a/docs/en/Getting_Started.md +++ b/docs/en/Getting_Started.md @@ -2,7 +2,7 @@ > Life was like a box of chocolates. You never know what you're gonna get. KMK is a keyboard focused layer that sits on top of [CircuitPython](https://circuitpython.org/). As such, it should work with most [boards that support CircuitPython](https://circuitpython.org/downloads). KMK requires CircuitPython version 7.0 or above. -Known working and recommended devices can be found [here](Officially_Supported_Microcontrollers.md) +Known working and recommended devices can be found at [Officially Supported Microcontrollers](Officially_Supported_Microcontrollers.md) ## TL;DR Quick start guide @@ -50,12 +50,12 @@ if __name__ == '__main__': > This is your last chance. After this, there is no turning back. You take the blue pill—the story ends, you wake up in your bed and believe whatever you want to believe. You take the red pill—you stay in Wonderland, and I show you how deep the rabbit hole goes. Remember: all I'm offering is the truth. Nothing more. ### You're extremely lucky and you have a fully supported keyboard -If your keyboard and microcontroller are officially supported, simply visit the page for your files, and dropping them on the root of the "flash drive". Those pages can be found [here](https://github.com/KMKfw/kmk_firmware/tree/master/boards). You will need the `kb.py` and `main.py`. More advanced instructions can be found [here](config_and_keymap.md). +If your keyboard and microcontroller are officially supported, simply visit the page for your files, and dropping them on the root of the "flash drive". Those pages can be found at [kmk firmware](https://github.com/KMKfw/kmk_firmware/tree/master/boards). You will need the `kb.py` and `main.py`. More advanced instructions can be found [config and keymap](config_and_keymap.md). ### You've got another, maybe DIY, board and want to customize KMK for it -First, be sure to understand how your device work, and particularly its specific matrix configuration. You can have a look [here](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) or read the [guide](https://docs.qmk.fm/#/hand_wire) provided by the QMK team for handwired keyboards +First, be sure to understand how your device work, and particularly its specific matrix configuration. You can have a look at [how key matrices work](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) or read the [guide](https://docs.qmk.fm/#/hand_wire) provided by the QMK team for handwired keyboards Once you've got the gist of it: -- You can have a look [here](config_and_keymap.md) and [here](keys.md) to start customizing your code.py / main.py file +- You can have a look at [config and keymap](config_and_keymap.md) and [keys](keys.md) to start customizing your code.py / main.py file - There's a [reference](keycodes.md) of the available keycodes - [International](international.md) extension adds keys for non US layouts and [Media Keys](media_keys.md) adds keys for ... media diff --git a/docs/en/ble_hid.md b/docs/en/ble_hid.md index a1f9b9f..15822cf 100644 --- a/docs/en/ble_hid.md +++ b/docs/en/ble_hid.md @@ -3,8 +3,8 @@ Bluetooth connections help clean up the wire mess! ## CircuitPython If not running KMKPython, this does require the adafruit_ble library from Adafruit. -This can be downloaded -[here](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble). +This can be downloaded at +[Adafruit CircuitPython BLE](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble). It is part of the [Adafruit CircuitPython Bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle). Simply put this in the "root" of your CircuitPython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device. diff --git a/docs/en/contributing.md b/docs/en/contributing.md index 21921df..3ede6b7 100644 --- a/docs/en/contributing.md +++ b/docs/en/contributing.md @@ -41,7 +41,7 @@ the docs. Documentation should be informative but concise. ### Styling Docs are written and rendered in GitHub Markdown. A comprehensive guide to GitHub's -Markdown can be found [here](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). +Markdown can be found at [basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). In particular, KMK's docs should include a title, demarcated with `#`, and subheadings should be demarcated with `##`, `###`, and so on. Headings should be short and specific. diff --git a/docs/en/flashing.md b/docs/en/flashing.md index f23bebe..7bdef70 100644 --- a/docs/en/flashing.md +++ b/docs/en/flashing.md @@ -24,9 +24,8 @@ make MOUNTPOINT=/media/CIRCUITPY USER_KEYMAP=user_keymaps/nameofyourkeymap.py BO Check to see if your drive may have mounted elsewhere with a GUI tool or other automounter. Most of these tools will mount your device under `/media`, probably -as `/media/CIRCUITPY`. If it's not mounted, you can read up on how to mount a -drive manually -[here](https://wiki.archlinux.org/index.php/File_systems#Mount_a_file_system). +as `/media/CIRCUITPY`. If it's not mounted, you can read up on how to [mount a +drive manually](https://wiki.archlinux.org/index.php/File_systems#Mount_a_file_system). For example, diff --git a/docs/en/handwiring.md b/docs/en/handwiring.md index ded3fe6..50ca1e2 100644 --- a/docs/en/handwiring.md +++ b/docs/en/handwiring.md @@ -1,6 +1,6 @@ # Handwire keyboards This guide will not talk about the physical wiring. Check out our [recommended microcontrollers](Officially_Supported_Microcontrollers.md) and -follow the amazing guide for that [here](https://docs.qmk.fm/#/hand_wire). That +follow the amazing guide for that [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) diff --git a/docs/en/kmkpython_vs_circuitpython.md b/docs/en/kmkpython_vs_circuitpython.md index 8a44a95..3510fac 100644 --- a/docs/en/kmkpython_vs_circuitpython.md +++ b/docs/en/kmkpython_vs_circuitpython.md @@ -15,7 +15,7 @@ the box. ### CircuitPython CircuitPython can be installed by following this guide using the guide -[here](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython). +[installing circuit python](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython). It's recommended to run the latest stable version that is at least 5.0 or higher. Beta versions may work, but expect limited support. #### Notable differences include diff --git a/docs/en/peg_oled_display.md b/docs/en/peg_oled_display.md index 97c1b40..4d93b2e 100644 --- a/docs/en/peg_oled_display.md +++ b/docs/en/peg_oled_display.md @@ -17,7 +17,7 @@ To use this you need to make some changes to your kb.py as well as you main.py I You need these frozen into your circuitpython or in a lib folder at the root of your drive. * [Adafruit_CircuitPython_DisplayIO_SSD1306](https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306) * [Adafruit_CircuitPython_Display_Text](https://github.com/adafruit/Adafruit_CircuitPython_Display_Text) -* [Download .mpy versions from here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20220415/adafruit-circuitpython-bundle-7.x-mpy-20220415.zip) +* [Download .mpy versions from Adafruit_CircuitPython_Bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20220415/adafruit-circuitpython-bundle-7.x-mpy-20220415.zip) ## kb.py diff --git a/docs/en/peg_rgb_matrix.md b/docs/en/peg_rgb_matrix.md index 6abe94e..57796d1 100644 --- a/docs/en/peg_rgb_matrix.md +++ b/docs/en/peg_rgb_matrix.md @@ -30,7 +30,7 @@ Currently this extension does not support changing LEDs at runtime, as a result The following libraries must be frozen in your CircuitPython distribution or in a 'lib' folder at the root of your drive. * [Adafruit_CircuitPython_NeoPixel](https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel) -* [Download .mpy versions from here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20220415/adafruit-circuitpython-bundle-7.x-mpy-20220415.zip) +* [Download .mpy versions from Adafruit_CircuitPython_Bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20220415/adafruit-circuitpython-bundle-7.x-mpy-20220415.zip) ## Required Changes to main.py and kb.py diff --git a/docs/en/porting_to_kmk.md b/docs/en/porting_to_kmk.md index d7390bb..e7a5deb 100644 --- a/docs/en/porting_to_kmk.md +++ b/docs/en/porting_to_kmk.md @@ -126,4 +126,4 @@ if __name__ == '__main__': ``` ## More information -More information on keymaps can be found [here](config_and_keymap.md) +More information on keymaps can be found at [config and keymap](config_and_keymap.md)