reactjs / reactjs/react-docgen
Documentation missing for most features
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
The current website is missing documentation for most features. Are there plans of adding this?
I'm trying to see how to use this tool to document components that use JSDoc for type definitions, and frankly don't know where to start. Is JSDoc even supported?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der aktuellen Website und der Repository-Beschreibung von react-docgen, um die Funktionen des Tools zu erfassen und festzustellen, wo Dokumentation fehlt. Prüfe, wie Komponentendateien mit JSDoc-Typdefinitionen verarbeitet werden; abgeschlossen bedeutet, dass die Website unterstützte Funktionen und deren Verwendung erklärt und angibt, ob JSDoc unterstützt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100