aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Challis <[email protected]>2024-06-22 05:45:04 +0100
committerGitHub <[email protected]>2024-06-22 05:45:04 +0100
commit7aa2ce2b38e7cf38f148d0781eae525d72260b8b (patch)
tree7319b2319fd3e692ca5c69cfbb6cba828dd6b0c5
parent6f03d20a92b01d656fe911aa025186056aefb9e9 (diff)
downloadqmk_firmware-7aa2ce2b38e7cf38f148d0781eae525d72260b8b.tar.gz
qmk_firmware-7aa2ce2b38e7cf38f148d0781eae525d72260b8b.zip
Update documentation suggestion in top level readme (#23978)
-rw-r--r--docs/contributing.md4
-rw-r--r--readme.md4
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 14025c2c50..43b2214d09 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -105,7 +105,9 @@ enum my_keycodes {
Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder:
- qmk docs
+```
+qmk docs
+```
and navigating to `http://localhost:5173/`.
diff --git a/readme.md b/readme.md
index 5025b40d95..5501089e86 100644
--- a/readme.md
+++ b/readme.md
@@ -12,9 +12,9 @@ This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github
* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm)
-The docs are powered by [VitePress](https://vitepress.dev/) and hosted on [GitHub](/docs/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details.
+The docs are powered by [VitePress](https://vitepress.dev/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details.
-You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit this page" link at the bottom of any page.
+You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls).
## Supported Keyboards