]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Improve docs "Edit Document" footer
authorfauxpark <fauxpark@gmail.com>
Wed, 18 Dec 2019 03:01:13 +0000 (14:01 +1100)
committerfauxpark <fauxpark@gmail.com>
Wed, 18 Dec 2019 03:01:13 +0000 (14:01 +1100)
docs/contributing.md
docs/index.html
readme.md

index 7c365b4186324f9fd54521f797b451e181dafdf2..c4d5057a07a0c643e847eeb3c42cb1ad924d86df 100644 (file)
@@ -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:
 
index 8d03c6edef5a741da1c74e7f4f32690001393626..9b33cd263a46bce1e6161b71f93f26259e2a8084 100644 (file)
@@ -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
index 5a9166c04426011376a69e8317d77d0f3a24d405..6092f209be1a05e3683e04e12bb391776b799a13 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -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