qmk/qmk_firmware

Develop some sort of include system for keycode documentation

Open

#4.610 aberto em 12 de dez. de 2018

Ver no GitHub
 (4 comments) (1 reaction) (0 assignees)C (43.867 forks)batch import
documentationenhancementgood first issuehelp wantedto do

Métricas do repositório

Stars
 (20.368 stars)
Métricas de merge de PR
 (Mesclagem média 20d 9h) (27 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue a geração atual de documentação no repositório do firmware QMK. Observe os arquivos de documentação de keycodes e os scripts de geração de documentação. Proponha um sistema para incluir keycodes de uma única fonte (por exemplo, um arquivo JSON ou cabeçalho C) que possa ser reutilizado em várias páginas de documentação.
Pilha de tecnologia
c
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60