qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Aperta

#4610 aperta il 12 dic 2018

Vedi su GitHubGuida contributor
 (4 commenti) (1 reazione) (0 assegnatari)C (43.867 fork)batch import
documentationenhancementgood first issuehelp wantedto do

Metriche repository

Star
 (20.368 stelle)
Metriche merge PR
 (Merge medio 20g 9h) (27 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga la generazione attuale della documentazione nel repository del firmware QMK. Esamina i file di documentazione dei keycode e gli script di generazione della documentazione. Proponi un sistema per includere i keycode da un'unica fonte (ad esempio un file JSON o header C) che possa essere riutilizzato in più pagine di documentazione.
Tech stack
c
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60