styleguidist/react-styleguidist

Make page per section configuration less confusing

Open

#1,145 opened on Sep 20, 2018

View on GitHub
 (20 comments) (1 reaction) (0 assignees)TypeScript (1,416 forks)github user discovery
help wantedrequest for comments

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Investigate the existing sectionDepth and pagePerSection options, review related issues #1139, #1137, #1058, and propose a new API design that simplifies configuration.
Tech stack
typescriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50