input-output-hk / partner-chains-smart-contracts

Command Line Tool and Cardano Plutus Contracts for interacting with Partner Chains.
Apache License 2.0
10 stars 2 forks source link

Updating the off-chain documentation #78

Closed jstolarek closed 3 months ago

jstolarek commented 3 months ago

Our documentation has gotten a bit out of date. This is a work-in-progress PR that points put some things that have gotten out of date (in particular: building and bundling the project). It also adds missing documentation for native token reserve management commands.

In general, the documentation needs more work. We should provide a detailed explanation of each command and its option, where "detailed" means more than the short explanation copied from the parser. In particular, how values of CLI options should be obtained? How to obtain the genesis utxo? How to obtain a signature? How to obtain asset currency symbol for the reserve tokens? Etc. This should be written in such a way that a person unfamiliar with the system knows how to obtain the required values and how to set up and use the CLI

Prereview checklist