patternfly / patternfly/patternfly-react

Consider adding Type documentation

Aperta
#9,767 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Good first issue Stale
Lingua principale
TypeScript
Stelle
862
Fork
392
Merge medio
4g 8h
PR unite (30g)
9

Descrizione

Describe the enhancement or change
Branching off from a conversation at https://github.com/patternfly/patternfly-react/pull/9709#pullrequestreview-1690213766, our Wizard component has several types that aren't really documented, but are still mentioned in the Prop tables. For example the Wizard's nav prop has a type of WizardNavType, which itself includes the CustomWizardNavFunction type, neither of which are explained on the Wizard component page (though there is an example that uses the CustomWizardNavFunction)

We want to wait until the new docs framework can implement a way to auto-add Type documentation, at which point these updates should be made to align with the new docs framework. This issue should cover adding Type documentation for all components, not just Wizard.

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.

Direzione di ricerca

Inizia dalla pagina del componente Wizard e dalla conversazione nel pull request #9709, in particolare dagli esempi WizardNavType e CustomWizardNavFunction. Esamina innanzitutto il supporto previsto dal nuovo framework di documentazione per la documentazione di Type; il lavoro è completo quando i tipi di tutti i componenti sono documentati in modo allineato a quel framework.

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
Abbastanza chiara
Idoneità per principianti
28/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.