Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create detailed documentation #16

Open
mrLSD opened this issue Apr 5, 2023 · 0 comments
Open

Create detailed documentation #16

mrLSD opened this issue Apr 5, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mrLSD
Copy link
Member

mrLSD commented Apr 5, 2023

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:

  1. Aurora Engine public methods, including views, their parameters, and responses.
  2. 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.

@mrLSD mrLSD added the documentation Improvements or additions to documentation label Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants