styleguidist/react-styleguidist

Make page per section configuration less confusing

Open

#1.145 aberto em 20 de set. de 2018

Ver no GitHub
 (20 comments) (1 reaction) (0 assignees)TypeScript (1.416 forks)github user discovery
help wantedrequest for comments

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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

Guia do colaborador

Direção de pesquisa
Investigue as opções existentes sectionDepth e pagePerSection, revise as issues relacionadas #1139, #1137, #1058 e proponha um novo design de API que simplifique a configuração.
Pilha de tecnologia
typescriptreact
Domain
frontend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Aguardando mantenedor
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GitReact
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50