loopbackio / loopbackio/loopback-next
CLI docs: unify reference guides and `lb4 --help`
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 5.1k
- Forks
- 1.1k
- Merge moyen
- 2 j 21 h
- PR mergées (30 j)
- 27
Description
At the moment, we have two different content describing CLI commands:
lb4 {command} --helpprints content generated by Yeoman based on generator arguments and options- Hand-written documentation pages in CLI Reference section, e.g. DataSource generator
It would be great to unify these two kinds of resources into a single source. (This idea was originally mentioned by @raymondfeng.)
For example, we can maintain CLI help in Markdown format and use a module like marked-terminal to allow lb4 --help to render the documentation to terminal. (Tangentially related: Get rid of Yeoman #844)
This story is a part of #5113 Documentation improvements 2020Q3
Acceptance criteria
TBD - will be filled by the team.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Comparez les pages de CLI Reference avec la sortie de lb4 {command} --help}, en commençant par le générateur de DataSource documenté et les points d’entrée actuels de l’aide. Définissez une source unique basée sur Markdown et vérifiez que les guides de référence comme l’aide du terminal l’utilisent ; les critères d’acceptation doivent encore être établis.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- nodejs, typescript
- Domaine
- cli, documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100