cli

cli copied to clipboard

Description

It would be beneficial for developers to get familiar with Ignite CLI packages. To enable that we could enhance the documentation with a new section that describes each individual package and gives some usage examples.

Initially we can start with the cosmosclient package and after it is finished we can create separate issues for the other packages.

Solution

• Create a new "Packages" section after the "Migration" section.
• Add a new item called "cosmosclient" inside the "Packages" section.
• Add an initial description to "cosmosclient" item that describes the cosmosclient package.
• Add a Go language example that show how to use the cosmosclient package to make a transfer between two cosmoshub accounts.

This is a great idea! Would it make sense to keep the documentation about modules in the code or right next to the code to make sure that the docs don't go out of sync with the code?

This is a great idea! Would it make sense to keep the documentation about modules in the code or right next to the code to make sure that the docs don't go out of sync with the code?

Indeed, when @ilgooz proposed it we talked about having this and at the end we agreed on having it as part of the documentation. I am thinking now that a middle term solution wouldn't be bad, where docs and examples could be kept in the code so they won't be out of sync while a short description and a link to the generated Go documentation could be part of the documentation because chances for the description to be changed or the module to be removed are low.