Docs generator for downstream CLI tools
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- shell, typescript
- Domínio
- cli, documentation
Direção de pesquisa
Comece lendo a documentação vinculada do Cobra sobre shell-completion e inspecione os pontos de entrada existentes do site de documentação do tab. Como nenhum arquivo ou teste é especificado na issue, determine primeiro onde uma página de documentação orientada por parâmetro de consulta deve ficar. Considera-se concluído quando uma página puder renderizar instruções de shell-completion personalizadas para o nome de uma ferramenta CLI.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
To learn more about the best way to enable completions in each shell, I read the Cobra docs: https://cobra.dev/docs/how-to-guides/shell-completion/
It has general guidance, plus shell-specific details.
If I was writing my own CLI tool, and I wanted to provide documentation for my end-users to enable completions in their shell, I might copy-paste Cobra's page and rename ./your-cli to my tool's name. What if tab could generate those docs for me?
This can even be a page on tab's documentation website which CLI authors can link to. It can read URL query parameters to customize the documentation, for example: https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
This page will render documentation, identical to cobra's page, customized for myfancycli. In the README for myfancycli, I can link to this page:
To enable completions, run myfancycli completion . For more detailed instructions see https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
- Linguagem predominante
- TypeScript
- Estrelas
- 282
- Forks
- 11
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
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 bombshell-dev/tab
-
An option is resolved from the root before the matched command, so a short name means one thing for the whole lineTalvez já em andamento @AmirSa12 assumiu há 16 dias. Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 56/100
bombshell-dev/tab#153 · 6 comentários ·
-
enhancement
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
bombshell-dev/tab#127 · 2 comentários ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
bombshell-dev/tab#118 ·
-
provide installation utilitiesTalvez já em andamento @theoephraim assumiu há 145 dias. Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
bombshell-dev/tab#117 ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
bombshell-dev/tab#107 · 3 comentários ·
Todas as issues de bombshell-dev/tab
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 83/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 72/100
zts212653/clowder-ai#1678 ·
Mantenedores costumam responder em até 1 dia
-
good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
Progressive-Victory/the-website#680 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100