styleguidist/react-styleguidist

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

Open

#1,170 opened on Oct 11, 2018

View on GitHub
 (9 comments) (3 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
documentationhelp wanted

Repository metrics

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

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.

Contributor guide

Research direction
Explore the styleguidist documentation and example themes for customizing layout. Check if tabs can be achieved using custom section rendering or themes. Look for existing issues or discussions about tabs and layout enhancements.
Tech stack
reacttypescript
Domain
frontenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactStyleguidistCSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60