loopbackio / loopbackio/loopback-next
CLI docs: unify reference guides and `lb4 --help`
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 5.1k
- Forks
- 1.1k
- Merge medio
- 2 d 21 h
- PR fusionados (30 d)
- 27
Descripción
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.
Guía de contribución
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.
Línea de trabajo
Compara las páginas de CLI Reference con la salida de lb4 {command} --help, empezando por el generador de DataSource documentado y los puntos de entrada actuales de la ayuda. Define una única fuente basada en Markdown y verifica que tanto las guías de referencia como la ayuda del terminal la utilicen; aún es necesario establecer los criterios de aceptación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- nodejs, typescript
- Área
- cli, documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100