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

Document gnoland, gnokey and gnodev commands #1987

Closed
Kouteki opened this issue Apr 26, 2024 · 8 comments
Closed

Document gnoland, gnokey and gnodev commands #1987

Kouteki opened this issue Apr 26, 2024 · 8 comments

Comments

@Kouteki
Copy link
Contributor

Kouteki commented Apr 26, 2024

As a Gno.land user ISBAT see all the available commands in the documentation and how I can utilize them so that I could accomplish my objective.

Acceptance criteria:

  1. Review PR feat: overhaul lazy init in gnoland start #1985 to understand the format needed for the documentation. Use it as a template for this task
  2. Sync with Onbloc on their effort to document gnoland commands
  3. Document gnoland commands OR help Onbloc document them on their own
  4. Document gnokey commands
  5. Document gnodev commands
@thehowl
Copy link
Member

thehowl commented May 7, 2024

FWIW, documentation should go on docs.gno.land, but there should be enough self-help also in the --help outputs; maybe one which does a bit less hand-holding and is more succinct

@leohhhn leohhhn moved this from Backlog to Priority 1 in 👥 Team: Devrels (Outdated) May 9, 2024
@leohhhn
Copy link
Contributor

leohhhn commented May 9, 2024

@Kouteki

Hey, about this issue - right now we already have docs on all of the tools (Gno Tooling section), albeit:

  • gnoland command is a bit outdated and @zivkovicmilos is working on a rewrite
  • gnodev should be up to date, was recently updated
  • gnokey - I took a look, and its mainly missing some of the new features, like MsgRun (issue for MsgRun)

What exactly do you think should be added?

@Kouteki
Copy link
Contributor Author

Kouteki commented May 10, 2024

FWIW, documentation should go on docs.gno.land, but there should be enough self-help also in the --help outputs; maybe one which does a bit less hand-holding and is more succinct

@thehowl just to be clear: your proposed improvement is enabling you to hit --help and get all the available parameters, instead of just a small subset currently shown?

@Kouteki
Copy link
Contributor Author

Kouteki commented May 10, 2024

@leohhhn I updated the description to be more specific. Let me know if you need additional clarification.

@leohhhn
Copy link
Contributor

leohhhn commented May 10, 2024

As discussed with @Kouteki, the action steps on this issue will be as follows:

And update missing/outdated things accordingly.

gnodev will have its place in the documentation in the Getting Started section with this PR, which should cover the "tutorial" part for it, and gnokey already has a section for it (Working with keypairs).

@zivkovicmilos
Copy link
Member

As discussed with @Kouteki, the action steps on this issue will be as follows:

And update missing/outdated things accordingly.

gnodev will have its place in the documentation in the Getting Started section with this PR, which should cover the "tutorial" part for it, and gnokey already has a section for it (Working with keypairs).

@leohhhn

The task is not just to review the existing pages, but to generate completely new documentation on how these tools are used, and under which circumstances they are used.
Please make sure we add meat into the docs for these tools, not just terminal copypastas

@leohhhn leohhhn moved this from Priority 1 to Backlog in 👥 Team: Devrels (Outdated) May 13, 2024
@Kouteki
Copy link
Contributor Author

Kouteki commented May 13, 2024

To clarify:

Our objective in this issue is to build learning oriented, tutorial style documentation. This documentation is part of the Getting Started section.

  1. We need to create Gnokey & gnoland pages in the Getting Started section, and write tutorials that cover use cases and steps. We also need to cover subcommands.
  2. We also need to update the existing Working with keypairs page. The format is good, the content needs to be reviewed and all the missing subcommands need to be added.

@Kouteki
Copy link
Contributor Author

Kouteki commented May 16, 2024

I've split the issue into more manageable pieces, closing this one.

@Kouteki Kouteki closed this as completed May 16, 2024
@zivkovicmilos zivkovicmilos closed this as not planned Won't fix, can't repro, duplicate, stale May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants