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 (43,867 forks)batch import
documentationenhancementgood first issuehelp wantedto do

Repository metrics

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

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

Research direction
Investigate the current documentation generation in the QMK firmware repository. Look at the keycode documentation files and the docs generation scripts. Propose a system to include keycodes from a single source (e.g., a JSON or C header file) that can be reused across documentation pages.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60