~ruther/qmk_firmware

7aa2ce2b38e7cf38f148d0781eae525d72260b8b — Joel Challis 1 year, 28 days ago 6f03d20
Update documentation suggestion in top level readme (#23978)

2 files changed, 5 insertions(+), 3 deletions(-)

M docs/contributing.md
M readme.md
M docs/contributing.md => docs/contributing.md +3 -1
@@ 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/`.


M readme.md => readme.md +2 -2
@@ 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