reactjs / reactjs/react-docgen
Documentation missing for most features
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 316
- Merge medio
- 5h 7m
- PR unite (30g)
- 4
Descrizione
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?
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dal sito web attuale e dalla descrizione del repository react-docgen per fare un inventario delle funzionalità dello strumento e determinare dove manca la documentazione. Verifica come vengono gestiti i file dei componenti che utilizzano definizioni di tipo JSDoc; il lavoro è completato quando il sito web spiega le funzionalità supportate, l'utilizzo e se JSDoc è supportato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- react, typescript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100