gpujs/gpu.js

Better looking natural docs

Open

#19 aperta il 28 feb 2016

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)JavaScript (756 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (14.837 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga la pipeline di generazione della documentazione attuale nel repository. Esamina la directory docs/ e qualsiasi file di configurazione della documentazione. Confronta la documentazione creata manualmente su http://gpu.rocks/getting started/ con quella generata su http://gpujs.github.io/dev docs/ per identificare differenze stilistiche specifiche. Considera l'uso di uno strumento di documentazione più recente o la personalizzazione di quello esistente. Controlla i commenti dell'issue per suggerimenti precedenti.
Tech stack
javascripthtmlcss
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Poco chiara
Prerequisiti
HTMLCSS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40