Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

Merge pull request #7666 from fauxpark/docs-edit-page

Browse source 
Improve docs "Edit Document" footer
This commit is contained in:
Joel Challis 2019-12-18 15:42:56 +00:00 committed by GitHub
commit b4bda14f3c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/contributing.md
View 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)! 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: 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:

4
docs/index.html
View file

@ -82,9 +82,9 @@
.replace('raw.githubusercontent.com', 'github.com') .replace('raw.githubusercontent.com', 'github.com')
.replace(/\/master/, '/blob/master') .replace(/\/master/, '/blob/master')
} else { } 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 return html
+ '\n\n----\n\n' + '\n\n----\n\n'
+ editHtml + editHtml

2
readme.md
View file

@ -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. 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 ## Supported Keyboards