patternfly / patternfly/patternfly-react
Consider adding Type documentation
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 862
- Forks
- 392
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 9
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la página del componente Wizard y la conversación del pull request #9709, especialmente con los ejemplos de WizardNavType y CustomWizardNavFunction. Primero revisa la compatibilidad prevista del nuevo framework de documentación con la documentación de Type; se considera terminado cuando los tipos de todos los componentes estén documentados de una forma alineada con ese framework.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 28/100