styleguidist/react-styleguidist

Improve single-component usage

Open

#195 opened on Oct 12, 2016

View on GitHub
 (16 comments) (5 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

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

Description

React Styleguidist could be awesome for documenting components, like this, but now it’s not.

  • New option to disable sidebar.
  • New option, getComponentName(), to change the title. @visibleName JSDoc tag — #933
  • “Fork me” ribbon with customisable URL.
  • New option to hide isolated link (needs discussion).
  • Hide path line if it’s empty.

Anything else? Any feedback?

Contributor guide

Research direction
Review the discussion in the issue comments to understand the desired new options (e.g., disable sidebar, hide isolated link). Examine the styleguidist source code to see how existing options are implemented, and propose adding a new configuration option with appropriate documentation.
Tech stack
reactjavascripttypescript
Domain
frontenddeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
ReactJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65