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.