aweary/react-copy-write

Create standalone documentation

Offen

#44 geöffnet am 27.06.2018

Auf GitHub ansehen
 (3 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (54 Forks)batch import
help wanted

Repository-Metriken

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

Beschreibung

The current README isn't great. I'd love to have an actual website for documentation with examples, tutorials, API reference, etc.

I'm leaning towards using https://docusaurus.io/. It looks easy to setup, and it's a Facebook product so dog-fooding is a plus.

Contributor Guide

Research-Richtung
Richten Sie eine Docusaurus Website für react copy write ein und schreiben Sie die erste Dokumentation mit Beispielen, Tutorials und API Referenz.
Tech Stack
javascriptreact
Domain
developer experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70