styleguidist/react-styleguidist

Improve single-component usage

Open

#195 ouverte le 12 oct. 2016

Voir sur GitHub
 (16 commentaires) (5 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

React Styleguidist could be awesome for documenting components, like this, but now it’s not.

  • New option to disable sidebar.
  • New option, getComponentName(), to change the title. @visibleName JSDoc tag — #933
  • “Fork me” ribbon with customisable URL.
  • New option to hide isolated link (needs discussion).
  • Hide path line if it’s empty.

Anything else? Any feedback?

Guide contributeur

Direction de recherche
Examinez la discussion dans les commentaires du problème pour comprendre les nouvelles options souhaitées (par exemple, désactiver la barre latérale, masquer le lien isolé). Examinez le code source de styleguidist pour voir comment les options existantes sont implémentées et proposez d'ajouter une nouvelle option de configuration avec une documentation appropriée.
Stack technique
reactjavascripttypescript
Domaine
frontenddeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
ReactJavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65