Skip to content

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

Open
@bajtos

Description

@bajtos

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Icebox

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions