qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Open

#4,610 opened on 2018年12月12日

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

説明

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.

コントリビューターガイド

技術スタック
c
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
QMK firmware basicskeycode definition filesdocumentation generation
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
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.