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

META: Revamp CLI Docs #4241

Open
19 tasks
salmad3 opened this issue Jul 3, 2024 · 1 comment
Open
19 tasks

META: Revamp CLI Docs #4241

salmad3 opened this issue Jul 3, 2024 · 1 comment
Labels
component:docs Documentation additions or improvements. epic type:feat To implement new feature. type:refactor

Comments

@salmad3
Copy link
Member

salmad3 commented Jul 3, 2024

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 #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 salmad3 added component:docs Documentation additions or improvements. epic type:refactor type:feat To implement new feature. labels Jul 3, 2024
@salmad3 salmad3 changed the title Revamp CLI Docs META: Revamp CLI Docs Jul 19, 2024
@michelleellen
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation additions or improvements. epic type:feat To implement new feature. type:refactor
Projects
Status: To Discuss
Development

No branches or pull requests

2 participants