cli icon indicating copy to clipboard operation
cli copied to clipboard

Ignite Network commands documentation - Iteration 2

Open lumtis opened this issue 2 years ago • 3 comments

This issue tracks the documentation to the writer for the second iteration of Network commands documentation https://docs.ignite.com/network/introduction

  • [ ] Page "launch your testnet on Gitpod" https://github.com/ignite/cli/pull/3377
  • [ ] Add a general section (for "chain enthusiast"?) users not interested in being validators but wanting tokens for testnet and participating in coordination for genesis
  • [x] Add a doc on how to request accounts with https://github.com/ignite/cli/issues/2945 in general section
  • [ ] Add page under coordinator guide for coordinator profile management @fadeev blocked on https://github.com/ignite/cli/issues/3390
  • [ ] Add page under validator guide for validator profile management @fadeev
  • [ ] Add in publish docs: documentation for initial genesis from config https://github.com/ignite/cli/pull/2950
  • [ ] Add more docs on publish option like --chain-id https://github.com/ignite/cli/issues/2951#issuecomment-1374434105
  • [ ] Document peer-node for join https://github.com/ignite/cli-plugin-network/pull/11
  • [x] Add remove-account and remove-validator documentation in then general section https://github.com/ignite/cli/issues/2966 https://github.com/ignite/cli/issues/2965
  • [ ] Add change-param in the general section https://github.com/ignite/cli/issues/2899
  • [ ] Add better information on account management @fadeev blocked on https://github.com/ignite/cli/issues/3390
  • [ ] Add docs for the AccountBalance option https://github.com/ignite/cli/issues/2951#issuecomment-1374432317
  • [ ] Document Revert Launch https://github.com/ignite/cli-plugin-network/pull/10

lumtis avatar Oct 19 '22 21:10 lumtis

Add docs for the AccountBalance option

Currently, we have the following:

Once the chain is published users can request accounts with coin balances to be added to the chain's genesis. By default, users are free to request any number of tokens. If you want all users requesting tokens to get the same amount, use the "--account-balance" flag with a list of coins.

ignite network chain publish github.com/ignite/example --account-balance 2000foocoin

What else do you think we should mention?

fadeev avatar Jan 07 '23 10:01 fadeev

Add more docs on publish option like --chain-id

Currently, we have the following:

The repository name is used as the default chain ID. Ignite does not ensure that chain IDs are unique, but they have to have a valid format: [string]-[integer]. To set a custom chain ID use the "--chain-id" flag.

   ignite network chain publish github.com/ignite/example --chain-id foo-1

What else do you think we should mention?

fadeev avatar Jan 07 '23 10:01 fadeev

I propose we transition the ignite network function to be installed as a seperate app with a seperate readme.md as is currently broken with the ignite network chain publish command. We could then remove the tutorial that does not work from the website docs.

mondainai247 avatar Feb 01 '24 19:02 mondainai247