styleguidist/react-styleguidist

Improve single-component usage

Open

#195 aberto em 12 de out. de 2016

Ver no GitHub
 (16 comments) (5 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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?

Guia do colaborador

Direção de pesquisa
Revise a discussão nos comentários da issue para entender as novas opções desejadas (por exemplo, desabilitar a barra lateral, ocultar link isolado). Examine o código fonte do styleguidist para ver como as opções existentes são implementadas e proponha adicionar uma nova opção de configuração com documentação apropriada.
Pilha de tecnologia
reactjavascripttypescript
Domain
frontenddeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
ReactJavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65