qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Open

#4.610 geöffnet am 12. Dez. 2018

Auf GitHub ansehen
 (4 Kommentare) (1 Reaktion) (0 zugewiesene Personen)C (43.867 Forks)batch import
documentationenhancementgood first issuehelp wantedto do

Repository-Metriken

Stars
 (20.368 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 9h) (27 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuchen Sie die aktuelle Dokumentationsgenerierung im QMK Firmware Repository. Sehen Sie sich die Keycode Dokumentationsdateien und die Skripte zur Dokumentationsgenerierung an. Schlagen Sie ein System vor, um Keycodes aus einer einzigen Quelle (z.B. eine JSON oder C Header Datei) einzubinden, das über mehrere Dokumentationsseiten hinweg wiederverwendet werden kann.
Tech Stack
c
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60