acl-services / acl-services/paprika

InlineEditors documentation problems

Aberta
#995 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
JavaScript
Estrelas
54
Forks
10
Merge médio
1d 12h
PRs com merge (30d)
6

Descrição

The docs of the new InlineEditors components need some work:

- [x] there should be a standard readme.md file with the prop table
- [ ] ~do we need these interactive examples in the docs, plus stories? it's twice the maintenance~
- [ ] ~in the ListBox example, rename 'someOptions' to 'subscriptions'~
- [ ] ~the 'textarea' example is broken (clicking it, screen goes white)~
- [x] the 'textarea' example has the wrong props
- [x] there's no 'textarea' story
- [x] rename 'with in a table' story to 'ListBox within a table'

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Start by locating the InlineEditors docs sources, including the component readme.md and the ListBox/textarea story files. Check where the prop table, story names, and props are currently defined, then apply the requested updates: fix textarea props/story presence and rename the table story to "ListBox within a table." Run the project docs/storybook preview path used for component docs and verify the updated stories render cleanly with the missing textarea story present.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, react, storybook
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
58/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.