styleguidist/react-styleguidist

Documenting design systems: Support for tabs in component pages / more examples for layouts

Open

#1.170 geöffnet am 11. Okt. 2018

Auf GitHub ansehen
 (9 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
documentationhelp wanted

Repository-Metriken

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

Beschreibung

The problem

When using styleguidist for design system docs, not just as a component library, there is a lot of additional content that one want's to add to styleguidist. See article from Nathan Curtis here: https://medium.com/eightshapes-llc/documenting-components-9fe59b80c015 Styleguidist default templates are a bit tuned towards documenting component api and code examples. Eg. having props and methods first

In general I'd like to see a few more examples of themes for document page and for sidenav too. E.g. how to arrange stuff to tabs / paragraphs and prioritize.

I'm not sure if this needs actual new features, or just more examples.

Contributor Guide

Research-Richtung
Erkunde die styleguidist Dokumentation und Beispielthemen zur Anpassung des Layouts. Überprüfe, ob Tabs durch benutzerdefinierte Abschnittsdarstellung oder Themen erreicht werden können. Suche nach bestehenden Issues oder Diskussionen zu Tabs und Layout Verbesserungen.
Tech Stack
reacttypescript
Domain
frontenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ReactStyleguidistCSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60