gpujs/gpu.js

Better looking natural docs

Open

#19 ouverte le 28 févr. 2016

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)JavaScript (756 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (14 837 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez le pipeline actuel de génération de documentation dans le dépôt. Examinez le répertoire docs/ et tous les fichiers de configuration de documentation. Comparez la documentation créée manuellement sur http://gpu.rocks/getting started/ avec celle générée sur http://gpujs.github.io/dev docs/ pour identifier des différences de style spécifiques. Envisagez d'utiliser un outil de documentation plus récent ou de personnaliser celui existant. Vérifiez les commentaires de l'issue pour des suggestions antérieures.
Stack technique
javascripthtmlcss
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Peu claire
Prérequis
HTMLCSS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40