Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI docs: unify reference guides and lb4 --help #5774

Open
bajtos opened this issue Jun 19, 2020 · 0 comments
Open

CLI docs: unify reference guides and lb4 --help #5774

bajtos opened this issue Jun 19, 2020 · 0 comments

Comments

@bajtos
Copy link
Member

bajtos commented Jun 19, 2020

At the moment, we have two different content describing CLI commands:

  • lb4 {command} --help prints 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.

@bajtos bajtos changed the title CLI docs: unify reference guides with CLI help CLI docs: unify reference guides and lb4 --help Jun 19, 2020
@dhmlau dhmlau added the p3 label Jul 30, 2020
@dhmlau dhmlau added help wanted and removed 2020Q3 labels Aug 12, 2020
@stale stale bot added the stale label Sep 27, 2021
@achrinza achrinza removed the stale label Sep 27, 2021
@loopbackio loopbackio deleted a comment from stale bot Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Icebox
Development

No branches or pull requests

3 participants