gpujs/gpu.js

Better looking natural docs

Open

#19 geöffnet am 28. Feb. 2016

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (756 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (14.837 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie die aktuelle Dokumentationsgenerierungs Pipeline im Repository. Sehen Sie sich das docs/ Verzeichnis und alle Dokumentationskonfigurationsdateien an. Vergleichen Sie die manuell erstellte Dokumentation unter http://gpu.rocks/getting started/ mit der generierten unter http://gpujs.github.io/dev docs/, um spezifische Stilunterschiede zu identifizieren. Erwägen Sie die Verwendung eines neueren Dokumentationstools oder die Anpassung des bestehenden. Überprüfen Sie die Issue Kommentare auf frühere Vorschläge.
Tech Stack
javascripthtmlcss
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Unklar
Voraussetzungen
HTMLCSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40