styleguidist/react-styleguidist

Make page per section configuration less confusing

Open

#1145 aperta il 20 set 2018

Vedi su GitHub
 (20 commenti) (1 reazione) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wantedrequest for comments

Metriche repository

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

Descrizione

We have quite a lot of issues related to sections configuration, especially the new sectionDepth option. It seems hard to understand (and honestly I don't understand it too).

@okonet @bebraw @rafaesc How can we improve this API? It would probably make more sense to have an option on each section that will define whether this section should be rendered with all subsections or not. But I don't have enough experience with pagePerSection option to say much.

Related issues: #1139 #1137 #1058

Guida contributor

Direzione di ricerca
Analizza le opzioni esistenti sectionDepth e pagePerSection, esamina i problemi correlati #1139, #1137, #1058 e proponi una nuova progettazione API che semplifichi la configurazione.
Tech stack
typescriptreact
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
In attesa del maintainer
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitReact
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50