Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-15410

CLI: cli module internal documentation is obsolete

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • None
    • Release Notes Required

    Description

      Internal documentation for cli module which represented by modules/cli/README.md file is obsolete.

      It seems that internal documentation of cli module should be developer oriented and should not consist of list of possible commands. Instead it should describe module design and 'How to' sections which describe how new commands, arguments, etc could be added.

      Also it makes sense to add reference to user oriented document which describes Ignite CLI commands: docs/_docs/ignite-cli-tool.adoc

      Attachments

        Activity

          People

            Unassigned Unassigned
            agura Andrey N. Gura
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: