gpujs/gpu.js

Better looking natural docs

Open

#19 aberto em 28 de fev. de 2016

Ver no GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (756 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (14.837 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

This: http://gpu.rocks/getting-started/

is over 9000 times better then

This: http://gpujs.github.io/dev-docs/

Problem is the former is manually created, the later is generated.

And so far from every JS documentation engine i use, they have quirks, or something off about it. NaturalDocs for all its "old-fashion" looks, works.

Basically we need to replace this or fix it.

Guia do colaborador

Direção de pesquisa
Investigue o pipeline atual de geração de documentação no repositório. Examine o diretório docs/ e quaisquer arquivos de configuração de documentação. Compare a documentação criada manualmente em http://gpu.rocks/getting started/ com a gerada em http://gpujs.github.io/dev docs/ para identificar diferenças de estilo específicas. Considere usar uma ferramenta de documentação mais recente ou personalizar a existente. Verifique os comentários da issue para sugestões anteriores.
Pilha de tecnologia
javascripthtmlcss
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Pouco claro
Prerequisites
HTMLCSS
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40