Docs generator for downstream CLI tools
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- shell, typescript
- Área
- cli, documentation
Línea de trabajo
Comienza leyendo la documentación enlazada de Cobra sobre shell-completion e inspecciona los puntos de entrada existentes del sitio web de documentación de tab. Como el issue no especifica archivos ni tests, determina primero dónde debe ubicarse una página de documentación controlada por un parámetro de consulta. Se considera terminado cuando una página puede mostrar instrucciones de shell-completion personalizadas para el nombre de una herramienta CLI.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- TypeScript
- Estrellas
- 282
- Forks
- 11
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más 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 linePosiblemente ocupada @AmirSa12 la tomó hace 5 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 56/100
bombshell-dev/tab#153 · 6 comentarios ·
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
bombshell-dev/tab#127 · 2 comentarios ·
-
support completions for npx/bunxAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
bombshell-dev/tab#118 ·
-
provide installation utilitiesPosiblemente ocupada @theoephraim la tomó hace 135 días. Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
bombshell-dev/tab#117 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
bombshell-dev/tab#107 · 3 comentarios ·
Todos los issues de bombshell-dev/tab
Issues similares
-
bug go
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
genkit-ai/genkit#6761 · 1 comentario ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
NousResearch/hermes-agent#136483 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
facioquo/stock-indicators-dotnet#2316 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
vercel-labs/skills#2460 ·
Los mantenedores suelen responder en 1 día