qmk/qmk_firmware

Improve mod-tap documentation

Open

#10,087 opened on Aug 19, 2020

View on GitHub
 (1 comment) (4 reactions) (0 assignees)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

I made a cheatsheet to understand mod-taps better: modtap_v2.pdf (original open office document: modtap.zip)

It's based on information from https://github.com/qmk/qmk_firmware/issues/8971, https://docs.google.com/spreadsheets/d/1IaaOMbl6zLBb5Jswyr90Lp9hGx3xIyugVSfD_oBk4po/edit#gid=0 and discussions with @sigprof.

I'd like to help make the docs on mod-taps a little better with these or similar images, although I'm not sure what the best way would be. Suggestions are welcome.

Contributor guide

Research direction
Review the existing mod tap documentation in the QMK docs repository and propose improvements using the attached cheatsheet and spreadsheet references. Create a pull request with updated documentation, potentially including the cheatsheet as an image or link.
Tech stack
c
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85