styleguidist/react-styleguidist

Documenting design systems: Support for tabs in component pages / more examples for layouts

Open

#1170 aperta il 11 ott 2018

Vedi su GitHub
 (9 commenti) (3 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
documentationhelp wanted

Metriche repository

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

Descrizione

The problem

When using styleguidist for design system docs, not just as a component library, there is a lot of additional content that one want's to add to styleguidist. See article from Nathan Curtis here: https://medium.com/eightshapes-llc/documenting-components-9fe59b80c015 Styleguidist default templates are a bit tuned towards documenting component api and code examples. Eg. having props and methods first

In general I'd like to see a few more examples of themes for document page and for sidenav too. E.g. how to arrange stuff to tabs / paragraphs and prioritize.

I'm not sure if this needs actual new features, or just more examples.

Guida contributor

Direzione di ricerca
Esplora la documentazione di styleguidist e i temi di esempio per personalizzare il layout. Verifica se le schede possono essere ottenute tramite il rendering di sezioni personalizzate o temi. Cerca problemi o discussioni esistenti sulle schede e sui miglioramenti del layout.
Tech stack
reacttypescript
Dominio
frontenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ReactStyleguidistCSS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60