styleguidist/react-styleguidist

Make page per section configuration less confusing

Open

#1.145 geöffnet am 20. Sept. 2018

Auf GitHub ansehen
 (20 Kommentare) (1 Reaktion) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
help wantedrequest for comments

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuchen Sie die vorhandenen Optionen sectionDepth und pagePerSection, überprüfen Sie die zugehörigen Issues #1139, #1137, #1058 und schlagen Sie ein neues API Design vor, das die Konfiguration vereinfacht.
Tech Stack
typescriptreact
Domain
frontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Wartet auf Maintainer Antwort
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitReact
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50