qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Open

#4 610 ouverte le 12 déc. 2018

Voir sur GitHub
 (4 commentaires) (1 réaction) (0 assignés)C (43 867 forks)batch import
documentationenhancementgood first issuehelp wantedto do

Métriques du dépôt

Stars
 (20 368 stars)
Métriques de merge PR
 (Merge moyen 20j 9h) (27 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Examinez la génération actuelle de la documentation dans le dépôt du firmware QMK. Regardez les fichiers de documentation des keycodes et les scripts de génération de documentation. Proposez un système pour inclure les keycodes à partir d'une source unique (par exemple un fichier JSON ou d'en tête C) qui peut être réutilisé dans plusieurs pages de documentation.
Stack technique
c
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60