diff options
| author | Joel Challis <git@zvecr.com> | 2019-12-18 15:42:56 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-18 15:42:56 +0000 |
| commit | b4bda14f3c73a3550ea3c415d76cac3ada63b7ab (patch) | |
| tree | aec553ab9357cdb65fe0d338fb9f407f4399a035 | |
| parent | f42dd61b8d29f71af2ce479064c64c96fef55ad4 (diff) | |
| parent | 3c190f8927f8676febb5e247908d2bdfd574a54b (diff) | |
Merge pull request #7666 from fauxpark/docs-edit-page
Improve docs "Edit Document" footer
| -rw-r--r-- | docs/contributing.md | 2 | ||||
| -rw-r--r-- | docs/index.html | 4 | ||||
| -rw-r--r-- | readme.md | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 7c365b4186..c4d5057a07 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -85,7 +85,7 @@ Limited experimentation on the devices I have available shows that 7 is high eno Documentation is one of the easiest ways to get started contributing to QMK. Finding places where the documentation is wrong or incomplete and fixing those is easy! We also very badly need someone to edit our documentation, so if you have editing skills but aren't sure where or how to jump in please [reach out for help](#where-can-i-go-for-help)! -You'll find all our documentation in the `qmk_firmware/docs` directory, or if you'd rather use a web based workflow you can click "Suggest An Edit" at the top of each page on http://docs.qmk.fm/. +You'll find all our documentation in the `qmk_firmware/docs` directory, or if you'd rather use a web based workflow you can click the "Edit this page" link at the bottom of each page on https://docs.qmk.fm/. When providing code examples in your documentation, try to observe naming conventions used elsewhere in the docs. For example, standardizing enums as `my_layers` or `my_keycodes` for consistency: diff --git a/docs/index.html b/docs/index.html index 8d03c6edef..9b33cd263a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -82,9 +82,9 @@ .replace('raw.githubusercontent.com', 'github.com') .replace(/\/master/, '/blob/master') } else { - url = 'https://github.com/qmk/qmk_firmware/blob/master/docs/' + vm.route.file + url = 'https://github.com/qmk/qmk_firmware/edit/master/docs/' + vm.route.file } - var editHtml = '[:memo: Edit Document](' + url + ')\n' + var editHtml = ':pencil2: [Edit this page](' + url + ')\n' return html + '\n\n----\n\n' + editHtml @@ -15,7 +15,7 @@ This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github The docs are powered by [Docsify](https://docsify.js.org/) 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. -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 Document" 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), or by clicking the "Edit this page" link at the bottom of any page. ## Supported Keyboards |