patternfly / patternfly/patternfly-react

Consider adding Type documentation

Ouverte
#9,767 7 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Good first issue Stale
Langage dominant
TypeScript
Étoiles
862
Forks
392
Merge moyen
4 j 8 h
PR mergées (30 j)
9

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la page du composant Wizard et la conversation du pull request #9709, en particulier les exemples WizardNavType et CustomWizardNavFunction. Examinez d’abord la prise en charge prévue de la documentation de Type par le nouveau framework de documentation ; c’est terminé lorsque les types de tous les composants sont documentés d’une manière conforme à ce framework.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
react, typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
28/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.