styleguidist/react-styleguidist

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

Open

#1 170 ouverte le 11 oct. 2018

Voir sur GitHub
 (9 commentaires) (3 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
documentationhelp wanted

Métriques du dépôt

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

Description

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.

Guide contributeur

Direction de recherche
Explorez la documentation de styleguidist et les themes d'exemple pour personnaliser la mise en page. Verifiez si les onglets peuvent etre realises via le rendu de sections personnalisees ou des themes. Recherchez des problemes ou discussions existants sur les onglets et les ameliorations de mise en page.
Stack technique
reacttypescript
Domaine
frontenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
ReactStyleguidistCSS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60