cli icon indicating copy to clipboard operation
cli copied to clipboard

META: Revamp CLI Docs

Open salmad3 opened this issue 1 year ago • 1 comments

Context:

The documentation at docs.ignite.com requires enhancements to improve utility and usability for users. This involves repurposing and reorganizing existing materials, as well as creating new content. Ensuring consistent terminology and clear navigation will help users efficiently find the information they need.

Follows https://github.com/ignite/cli/issues/4236

There is also a need for a new information architecture for the CLI docs and within the broader context of Ignite content (i.e., tutorials.ignite.com).

Topics not covered in the docs:

  • [BLOCKED] ICS Consumer Chains
    • ICS is not yet compatible with SDK v0.50, which Ignite uses
    • Implementation within Ignite also requires provider chain.
  • ...

WIP - Acceptance Criteria:

Repurpose into quick starts:

General repurpose:

Reference:

  • [ ] Revamp the command reference doc
    • Consider creating a manpage
    • Categorization
    • Easier navigation
    • Easier accessibility on sidebar

General:

  • [ ] Reference and link to tutorials.ignite.com
  • [ ] Create an explainer section to capture all conceptual and theoretical material. This includes repurposing existing content and creating new content based on the CLI's implementation, configuration, and dependancies.
  • [ ] Ensure "Apps" are updated to "Extensions"
  • [ ] Refactor footer:
    • "Products" should change as the docs are CLI-specific.
    • Company-specific links can be removed.
    • Remove Accelerator
    • Remove "Business Inquiries"

salmad3 avatar Jul 03 '24 14:07 salmad3

Hi @toschdev and @salmad3 can we prioritize this?

  • Based on analytics, I suggest we move the reference section up, CLI Commands and Configuration File seem to be visible
  • We need to create a Tutorial section and I think we can leave Hello World and Blog tutorial for now and an image with a link 'Ignite Tutorials' and send people to our tutorials website.

michelleellen avatar Jul 30 '24 08:07 michelleellen