-
Notifications
You must be signed in to change notification settings - Fork 14
Description
What should be done
Create documentation for:
- all commands and subcommands
- include all parameters for commands
- for
Aurora Engine
specific commands - create a full list of available calls, their parametres and responses - same for
NEAR Protocol
specific commands
Motivation
As a first-time coming user, I need detailed documentation and instructions on how to use aurora-cli
. As far as I can see currently it's two main commands: engine
and near
. And it means communication with Aurora Engine
smart contract, and NEAR Protocol
itself.
For now, to use aurora-cli
, I should deep diving to Aurora Engine
code to understand what functions, parameters, and responses I can use (Aurora Engine
do not have full-featured documentation for that). Especially how to use it with CLI commands, for example with "borshified" parameters.
It will be good to have documentation for all commands and parameters for it.
Also, it will be good to have documentation, instructions, and examples for each one for:
Aurora Engine
public methods, including views, their parameters, and responses.NEAR Protocol
public methods, including views, their parameters, and responses.
Having this kind of documentation, that covers all cases of use for aurora-cli
makes this tool useful and convenient for real-world usage, for users that do not have enough context about Aurora Engine
and NEAR protocol
commands.