styleguidist/react-styleguidist

Make page per section configuration less confusing

Open

#1 145 ouverte le 20 sept. 2018

Voir sur GitHub
 (20 commentaires) (1 réaction) (0 assignés)TypeScript (1 416 forks)github user discovery
help wantedrequest for comments

Métriques du dépôt

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

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

Guide contributeur

Direction de recherche
Examinez les options existantes sectionDepth et pagePerSection, examinez les problèmes connexes #1139, #1137, #1058 et proposez une nouvelle conception d'API qui simplifie la configuration.
Stack technique
typescriptreact
Domaine
frontend
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.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
En attente d'un mainteneur
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitReact
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50