Documentation missing for most features

Aperta
#933 1 commento 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
react, typescript
Ambito
documentation

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.

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?

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
3h 28m
PR unite (30g)
6

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactjs/react-docgen

Tutte le issue di reactjs/react-docgen

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.