patternfly / patternfly/patternfly-react

Consider adding Type documentation

Offen
#9,767 7 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Good first issue Stale
Vorherrschende Sprache
TypeScript
Sterne
862
Forks
392
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
9

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Seite zur Wizard-Komponente und der Unterhaltung im pull request #9709, insbesondere mit den Beispielen für WizardNavType und CustomWizardNavFunction. Prüfe zuerst die geplante Unterstützung für Type-Dokumentation im neuen Dokumentations-Framework; als erledigt gilt die Aufgabe, wenn die Typen für alle Komponenten auf eine Weise dokumentiert sind, die mit diesem Framework übereinstimmt.

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
Größtenteils klar
Anfängerfreundlichkeit
28/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.