qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Open

#4,610 opened on Dec 12, 2018

View on GitHub
 (4 comments) (1 reaction) (0 assignees)C (20,368 stars) (43,867 forks)batch import
documentationenhancementgood first issuehelp wantedto do

Description

Feature Request Type

  • Core Functionality
  • Add-on hardware support (e.g. audio, RGB, OLED screen, etc.)
  • Alteration (enhancement/optimization) of existing Feature(s)
  • New behavior

Description

As discussed in discord, it would be really nice to have some sort of system for generating https://docs.qmk.fm/#/keycodes and all of the keycodes on the Features pages from a single source. This would help prevent those pages from falling out of sync with one another and make it easier to update with new keycodes.

Contributor guide

Tech stack
c
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
QMK firmware basicskeycode definition filesdocumentation generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the current keycode documentation at https://docs.qmk.fm/#/keycodes and the corresponding source files in the repository. Look at how keycodes are defined in the C source files (e.g., quantum/keycodes.h) and how the documentation is generated (likely using doxygen or a custom script). Investigate existing issue comments for any pointers to a proposed include system. Check if there are any related files or branches that attempt to solve this. Then design a system that extracts keycode definitions from a single source and generates the documentation pages dynamically, ensuring they stay in sync.
Develop some sort of include system for keycode documentation · qmk/qmk_firmware#4610 | Good First Issue