anikethsaha/create-web-app

Adding Docs

Offen

#7 geöffnet am 28.05.2019

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (3 Forks)auto 404
dependenciesdocsenhancementgood first issuehacktoberfesthelp wanted

Repository-Metriken

Stars
 (15 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Feature To add documentation creation library and writing docs for the package.

Library Suggestion

Our first Major release will be after completion of this feature.

updated

It would be helpful too if we get improvement on current docs that is on readme(s)

Contributor Guide

Research-Richtung
Bewerten Sie Dokumentationsgenerierungsbibliotheken wie Typedoc, Docsify, Docusaurus und documentationjs. Wählen Sie diejenige aus, die am besten zu den Projektanforderungen passt, und integrieren Sie sie, um Dokumentation aus TypeScript Quellcode zu generieren. Verbessern Sie auch die vorhandene README Dokumentation.
Tech Stack
typescript
Domain
documentationdeveloper experience
Issue Type
Funktion
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70