qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Open

#4,610 建立於 2018年12月12日

在 GitHub 查看
 (4 留言) (1 反應) (0 負責人)C (20,368 star) (43,867 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.
Develop some sort of include system for keycode documentation · qmk/qmk_firmware#4610 | Good First Issue