Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up Tap Dance docs #9372

Merged
merged 2 commits into from
Jun 18, 2020
Merged

Conversation

fauxpark
Copy link
Member

Description

Mostly fixing code style, removing references to the deprecated ACTION_FUNCTION_TAP and trying to clarify the simple example (in particular, where to put the TD() keycode).

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@fauxpark fauxpark requested a review from a team June 11, 2020 09:57
Copy link
Contributor

@rmwphd rmwphd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, except that in line 330, :id=example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys shows up in the rendered Markdown. It's the only header with an :id appended like that and I'm not sure why. Could be some restriction on id-ing headers of level 4 rather than 3?

@fauxpark
Copy link
Member Author

That's normal; it's for translation purposes, since the heading links in Docsify are otherwise autogenerated from the heading text: https://docsify.now.sh/helpers?id=customise-id-for-headings

I should probably fill the rest of them in, though.

Copy link
Contributor

@rmwphd rmwphd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat! I didn't know that. Looks good!

@drashna
Copy link
Member

drashna commented Jun 15, 2020

Neat! I didn't know that. Looks good!

Another trick is, if you check out the code changes, you can run qmk docs to run a local webserver with the docs.

Copy link
Member

@noroadsleft noroadsleft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@noroadsleft noroadsleft merged commit 1a159a3 into qmk:master Jun 18, 2020
@noroadsleft
Copy link
Member

Thanks!

@fauxpark fauxpark deleted the tapdance-docs-cleanup branch June 18, 2020 00:14
Shinichi-Ohki added a commit to Shinichi-Ohki/qmk_firmware that referenced this pull request Jun 18, 2020
* 'master' of https://github.com/qmk/qmk_firmware: (36 commits)
  [Keyboard] Jian keyboard (qmk#8914)
  Implement game mode layer for dcompact on planck (qmk#9402)
  [Keymap] new keymap for XD75 (qmk#8675)
  Clean up Tap Dance docs (qmk#9372)
  CLI: Add ATmega328 and ATtiny85 to supported CPUs (qmk#9371)
  Fix error_log complaint about clueboard/66_hotswap/gen1 layout macro (qmk#9400)
  Nebula65 (qmk#9368)
  added 4x12 (qmk#9411)
  [Keymap] Add froggy keymap with 106/109 (JP) settings for helix keyboard (qmk#8967)
  [Keymap] csc027/keymap-updates (qmk#9420)
  Add VIA support to keebio/nyquist (qmk#9399)
  [Keymap] Drashna's Keymap Update - Display Edition (qmk#9282)
  [Keymap] Add "shwilliam" Preonic keymap (qmk#9409)
  HID Liberation Device Refactor and Configurator layout support (qmk#9394)
  [Keyboard] Fix Configurator layout data for handwired/1800fl (qmk#9393)
  [Keyboard] Fix Configurator layout data for acheron/elongate (qmk#9392)
  Change ?= to = in keyboard rules.mk (qmk#9390)
  [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (qmk#9380)
  [Keyboard] Hub16 keymap bugfix (qmk#9345)
  [Keyboard] Add Eon75 (qmk#9333)
  ...
jakobaa pushed a commit to jakobaa/qmk_firmware that referenced this pull request Jul 7, 2020
* Clean up Tap Dance docs

* Add heading IDs for translation
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* Clean up Tap Dance docs

* Add heading IDs for translation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants