von-network icon indicating copy to clipboard operation
von-network copied to clipboard

Update `./manage cli` documentation or functionality

Open WadeBarnes opened this issue 2 years ago • 4 comments

The ./manage cli command no longer works as described in the Connecting to the Network section of the main readme.

Either update the documentation to reference the Using the containerized indy-cli, or modify the scripts so the command functions as described.

WadeBarnes avatar Jun 22 '23 16:06 WadeBarnes

@swcurran, @esune, Any opinion on which option you'd like to see implemented?

WadeBarnes avatar Jun 22 '23 16:06 WadeBarnes

Given that ./manage is ubiquitous in von-network, my gut says to fix the scripts to make sense, and adjust the documentation if there is a gap.

If the other reference is complete and sufficient, then removing the “cli” section from ./manage would be the next minimum.

@WadeBarnes:

  • Which is the least estimated effort, and by how much?
  • Which do you think is the best result?

swcurran avatar Jun 22 '23 17:06 swcurran

It would be nice to have a simplified startup process that works with any ledger, not just von-network. The previous functionality described by the documentation relied on the IP address to point to a von-network instance where it could infer the URL to the genesis file. So after thinking about this for a bit, it might not be appropriate to resurrect the documented functionality.

Updating the documentation would be the least amount of effort. Resurrecting the documented functionality would take an hour or so.

WadeBarnes avatar Jun 23 '23 14:06 WadeBarnes

If I got it right, I agree that updating the docs to use the newer/up-to-date method (containerized cli) is probably the best way forward.

esune avatar Jul 07 '23 00:07 esune