Skip to content

Commit

Permalink
Update QMK doc links.
Browse files Browse the repository at this point in the history
  • Loading branch information
getreuer committed Jun 8, 2024
1 parent fdd9170 commit 46c336c
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ Sturdy](https://getreuer.info/posts/keyboards/alt-layouts/index.html#magic-sturd
## Installation

This repo works as an [External QMK
Userspace](https://docs.qmk.fm/#/newbs_external_userspace). Instructions on how
Userspace](https://docs.qmk.fm/newbs_external_userspace). Instructions on how
to use it in QMK:

1. [Set up QMK](https://docs.qmk.fm/#/newbs).
1. [Set up QMK](https://docs.qmk.fm/newbs).

2. Clone this repo locally

Expand Down
2 changes: 1 addition & 1 deletion features/achordion.h
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ uint16_t achordion_timeout(uint16_t tap_hold_keycode);
* }
*
* @note `mod` should be compared with `MOD_` prefixed codes, not `KC_` codes,
* described at <https://docs.qmk.fm/#/mod_tap>.
* described at <https://docs.qmk.fm/mod_tap>.
*
* @param mod Modifier `MOD_` code.
* @return True if the modifier should be eagerly applied.
Expand Down
2 changes: 1 addition & 1 deletion features/autocorrection.c
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
#include "autocorrection_data.h"

#pragma message \
"Autocorrect is now a core QMK feature! To use it, update your QMK set up and see https://docs.qmk.fm/#/feature_autocorrect"
"Autocorrect is now a core QMK feature! To use it, update your QMK set up and see https://docs.qmk.fm/features/autocorrect"

#if AUTOCORRECTION_MIN_LENGTH < 4
// Odd output or hard locks on the board have been observed when the min typo
Expand Down
2 changes: 1 addition & 1 deletion features/autocorrection.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* --------
*
* @note Autocorrect is now a core QMK feature! See
* <https://docs.qmk.fm/#/feature_autocorrect>
* <https://docs.qmk.fm/features/autocorrect>
*
* Some words are more prone to typos than others. This userspace QMK library
* implements rudimentary autocorrection, automatically detecting and fixing
Expand Down
2 changes: 1 addition & 1 deletion features/caps_word.c
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include "caps_word.h"

#pragma message \
"Caps Word is now a core QMK feature! To use it, update your QMK set up and see https://docs.qmk.fm/#/feature_caps_word"
"Caps Word is now a core QMK feature! To use it, update your QMK set up and see https://docs.qmk.fm/features/caps_word"

#if !defined(IS_QK_MOD_TAP)
// Attempt to detect out-of-date QMK installation, which would fail with
Expand Down
2 changes: 1 addition & 1 deletion features/caps_word.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* --------
*
* @note Caps Word is now a core QMK feature! See
* <https://docs.qmk.fm/#/feature_caps_word>
* <https://docs.qmk.fm/features/caps_word>
*
* This library implements "Caps Word", which is like conventional Caps Lock,
* but automatically disables itself at the end of the word. This is useful for
Expand Down
2 changes: 1 addition & 1 deletion features/repeat_key.c
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#include "repeat_key.h"

#pragma message \
"Repeat Key is now a core QMK feature! To use it, update your QMK set up and see https://docs.qmk.fm/#/feature_repeat_key"
"Repeat Key is now a core QMK feature! To use it, update your QMK set up and see https://docs.qmk.fm/features/repeat_key"

#if !defined(IS_QK_MOD_TAP)
// Attempt to detect out-of-date QMK installation, which would fail with
Expand Down
2 changes: 1 addition & 1 deletion features/repeat_key.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* @brief Repeat Key - an extensible "repeat last key" implementation.
*
* @note Repeat Key is now a core QMK feature! See
* <https://docs.qmk.fm/#/feature_repeat_key>
* <https://docs.qmk.fm/features/repeat_key>
*
* Repeat Key performs the action of last pressed key. Tapping the Repeat Key
* after tapping the Z key types another "z." Repeat Key remembers the modifiers
Expand Down
12 changes: 6 additions & 6 deletions getreuer.c
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ enum custom_keycodes {


///////////////////////////////////////////////////////////////////////////////
// Combos (https://docs.qmk.fm/#/feature_combo)
// Combos (https://docs.qmk.fm/features/combo)
///////////////////////////////////////////////////////////////////////////////
const uint16_t caps_combo[] PROGMEM = {KC_J, KC_COMM, COMBO_END};
const uint16_t j_k_combo[] PROGMEM = {KC_J, KC_K, COMBO_END};
Expand Down Expand Up @@ -187,7 +187,7 @@ uint8_t NUM_CUSTOM_SHIFT_KEYS =
#endif // CUSTOM_SHIFT_KEYS_ENABLE

///////////////////////////////////////////////////////////////////////////////
// Tap-hold configuration (https://docs.qmk.fm/#/tap_hold)
// Tap-hold configuration (https://docs.qmk.fm/tap_hold)
///////////////////////////////////////////////////////////////////////////////
uint16_t get_tapping_term(uint16_t keycode, keyrecord_t* record) {
switch (keycode) {
Expand Down Expand Up @@ -252,7 +252,7 @@ uint16_t achordion_timeout(uint16_t tap_hold_keycode) {
#endif // ACHORDION_ENABLE

///////////////////////////////////////////////////////////////////////////////
// Autocorrect (https://docs.qmk.fm/#/feature_autocorrect)
// Autocorrect (https://docs.qmk.fm/features/autocorrect)
///////////////////////////////////////////////////////////////////////////////
#ifdef AUTOCORRECT_ENABLE
bool apply_autocorrect(uint8_t backspaces, const char* str,
Expand All @@ -266,7 +266,7 @@ bool apply_autocorrect(uint8_t backspaces, const char* str,
#endif // AUTOCORRECT_ENABLE

///////////////////////////////////////////////////////////////////////////////
// Caps word (https://docs.qmk.fm/#/feature_caps_word)
// Caps word (https://docs.qmk.fm/features/caps_word)
///////////////////////////////////////////////////////////////////////////////
#ifdef CAPS_WORD_ENABLE
bool caps_word_press_user(uint16_t keycode) {
Expand Down Expand Up @@ -338,7 +338,7 @@ char sentence_case_press_user(uint16_t keycode, keyrecord_t* record,
#endif // SENTENCE_CASE_ENABLE

///////////////////////////////////////////////////////////////////////////////
// Repeat key (https://docs.qmk.fm/#/feature_repeat_key)
// Repeat key (https://docs.qmk.fm/features/repeat_key)
///////////////////////////////////////////////////////////////////////////////
bool remember_last_key_user(uint16_t keycode, keyrecord_t* record,
uint8_t* remembered_mods) {
Expand Down Expand Up @@ -518,7 +518,7 @@ void caps_word_set_user(bool active) {
#endif // STATUS_LED_3

///////////////////////////////////////////////////////////////////////////////
// User macro callbacks (https://docs.qmk.fm/#/feature_macros)
// User macro callbacks (https://docs.qmk.fm/feature_macros)
///////////////////////////////////////////////////////////////////////////////

void keyboard_post_init_user(void) {
Expand Down
2 changes: 1 addition & 1 deletion tools/qmk_song_player/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h1 id="song-title">QMK song player</h1>
</div>

<p><b>What is this?</b> The box above is a QMK song player.
If you have a QMK keyboard with a speaker, you can use <a href="https://docs.qmk.fm/#/feature_audio">
If you have a QMK keyboard with a speaker, you can use <a href="https://docs.qmk.fm/features/audio">
the audio feature</a> to play simple songs.</p>

<script src="./main.min.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion tools/qmk_song_player/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"keywords": [],
"author": "Pascal Getreuer",
"license": "Apache-2.0",
"description": "The Quantum Mechanical Keyboard (QMK) firmware has a feature for playing simple songs (https://docs.qmk.fm/#/feature_audio?id=songs). This library reads song in QMK's song code syntax and plays them using Web Audio.",
"description": "The Quantum Mechanical Keyboard (QMK) firmware has a feature for playing simple songs (https://docs.qmk.fm/features/audio#songs). This library reads song in QMK's song code syntax and plays them using Web Audio.",
"devDependencies": {
"@types/jest": "^29.5.2",
"jest": "^29.5.0",
Expand Down
2 changes: 1 addition & 1 deletion tools/qmk_song_player/song.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* QMK song player.
*
* The Quantum Mechanical Keyboard (QMK) firmware has a feature for playing
* simple songs (https://docs.qmk.fm/#/feature_audio?id=songs). This library
* simple songs (https://docs.qmk.fm/features/audio#songs). This library
* reads song in QMK's song code syntax and plays them using Web Audio.
*/

Expand Down

0 comments on commit 46c336c

Please sign in to comment.