styleguidist/react-styleguidist

Status icons in component list

Open

#1,018 opened on Jun 15, 2018

View on GitHub
 (2 comments) (2 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wanted

Repository metrics

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

Description

The problem

No idea which items in the component list are new, deprecated, or under development/experimental. A good example would be GitHub's guide: https://styleguide.github.com/primer/

Proposed solution

Update ComponentsListRenderer to display the status based on docblock tags, like @new, @deprecated, and @experimental. Tag descriptions would be shown in a tooltip.

Alternative solutions

N/A

Additional context

I'm testing this currently by overriding SG components. Will report back.

Contributor guide

Research direction
Implement status icon display in ComponentsListRenderer by parsing docblock tags (@new, @deprecated, @experimental) and showing tooltips with tag descriptions.
Tech stack
typescriptreact
Domain
frontenddocumentation
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactTypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75