styleguidist/react-styleguidist

Improve single-component usage

Open

#195 aperta il 12 ott 2016

Vedi su GitHub
 (16 commenti) (5 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
enhancementgood first issuehelp wanted

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Esamina la discussione nei commenti dell'issue per comprendere le nuove opzioni desiderate (es. disabilitare la barra laterale, nascondere il link isolato). Esamina il codice sorgente di styleguidist per vedere come sono implementate le opzioni esistenti e proponi di aggiungere una nuova opzione di configurazione con la documentazione appropriata.
Tech stack
reactjavascripttypescript
Dominio
frontenddeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
ReactJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65