Bad documentation for end user
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 65/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Domínio
- documentation
Direção de pesquisa
Comece lendo o site do projeto e a página NPM de @terraphim/autocomplete; em seguida, identifique a documentação existente voltada aos usuários que precisa ser aprimorada. Explique o que o produto faz, seus casos de uso, se o autocompletar é baseado no navegador ou em bindings, e como funcionam sua persistência, desempenho, limitações e reindexação. O trabalho estará concluído quando um novo usuário puder responder a essas perguntas sem explorar o produto.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
The problem
Hey, I've just checked your site and I can't answer the question "what is this?" because there are no explanations "what this product does for me as end user?" and "what's the use cases for this product?".
Also I've checked NPM https://www.npmjs.com/package/@terraphim/autocomplete and I see the same problems there. For me unclear
- what is this? is it autocomplete in browser or just a bindings?
- what is the persistence model?
- what about performance?
- what about limitations?
- what about re-indexing?
It seems currently this product have no the docs. But I've found this product on site with software announces. It seems you were work hard but can't explain why.
The solution
Improve the docs to make the purpose clear for end user who knows nothing about the product and don't want to waste any time to explore the product.
If you can't zoom-out to think as such user and to formulate good questions - I can help and will act as a pessimistic user, you can start with answers above.
- Linguagem predominante
- Rust
- Estrelas
- 74
- Forks
- 5
- Merge médio
- 3h 15min
- PRs com merge (30d)
- 29
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de terraphim/terraphim-ai
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 25/100
terraphim/terraphim-ai#995 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
terraphim_rlm: require a per-sub-result verification plan (recheck / control / independent route)Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
terraphim/terraphim-ai#969 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
terraphim/terraphim-ai#968 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
terraphim/terraphim-ai#967 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
terraphim/terraphim-ai#966 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de terraphim/terraphim-ai
Issues semelhantes
-
bug needs triage P3
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
pbakaus/impeccable#1143 ·
Mantenedores costumam responder em até 1 dia
-
Bundled uv is never updated and trusts the compromised eMudhra certificatesTalvez já em andamento @FabienDanieau assumiu hoje. Abertabug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
foxglove/mcap#1907 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 66/100
Mantenedores costumam responder em até 1 dia