styleguidist/react-styleguidist

Make page per section configuration less confusing

Open

#1,145 opened on 2018年9月20日

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)

説明

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

コントリビューターガイド

調査方針
既存のsectionDepthおよびpagePerSectionオプションを調査し、関連するIssue #1139、#1137、#1058を確認し、設定を簡素化する新しいAPI設計を提案してください。
技術スタック
typescriptreact
領域
frontend
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
メンテナーの返信待ち
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
GitReact
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50