Fixes and updates to docs #2611
Conversation
docs/config_options.md
Outdated
| @@ -34,6 +34,8 @@ This is a C header file that is one of the first things included, and will persi | |||
| ## `config.h` Options | |||
|
|
|||
| ### Hardware Options | |||
| ==================== | |||
There was a problem hiding this comment.
These are conflicting styles. The ### indicates a level 3 header, while the ==== underneath indicates a level 1 header.
There was a problem hiding this comment.
Not a problem. Will change.
Just really want a good way to make sure these headers are LINKABLE. And easily so.
Because apparently, no link comes up for these... and it would make things SOO much easier.
docs/feature_advanced_keycodes.md
Outdated
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| Your keymap can include keycodes that are more advanced than normal, for example shifted keys. This page documents the functions that are available to you. | |||
|
|
|||
| ### Assigning Custom Names | |||
| ## Assigning Custom Names | |||
There was a problem hiding this comment.
These level 3 headers were deliberate so they wouldn't make the TOC too confusing. With level 2 headers the TOC became big and hard to follow.
There was a problem hiding this comment.
I figured it was something like that....
And H3 ... get no links (nor love, apparently)
|
Is there some way to get the H3 stuff to be linkable? Some pages are "okay", but docs like the Config options is ... absolutely atrocious for references: |
|
For the config options case I think we can remove the |
|
Done. And I think that should help with ... well helping people. And if we could move over to the beta version .... that would fix many of the issues with linkability. |
|
Nice, thanks! |
Fixes a number of issues (such as links and formatting) and adds some updates/clarifications for other docs.