Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Docs generator for downstream CLI tools

Ouverte
  • Quelque chose ne va pas ?
#106 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
30/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
shell, typescript
Domaine
cli, documentation

Piste de recherche

Commencez par lire la documentation Cobra liée sur la complétion du shell et examinez les points d’entrée existants du site web de documentation de tab. Comme aucun fichier ni test n’est indiqué dans l’issue, déterminez d’abord où doit se trouver une page de documentation pilotée par un paramètre de requête. C’est terminé lorsqu’une page peut afficher des instructions de complétion du shell personnalisées pour le nom d’un outil CLI.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation enhancement

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

Langage dominant
TypeScript
Étoiles
282
Forks
11
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de bombshell-dev/tab

Toutes les issues de bombshell-dev/tab

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.