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

docs: add Using gnokey tutorial #2226

Merged
merged 112 commits into from
Sep 5, 2024
Merged

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented May 28, 2024

Description

This PR adds the Using gnokey tutorial to the documentation. It has three sections:

  • State-changing calls (transactions), which covers all Gno message types
  • ABCI queries, which covers all currently available query types
  • Making an airgapped transaction, which shows how to use the sign & broadcast functionalities in gnokey

Current state of the PR

Closes: #2126

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn
Copy link
Contributor Author

leohhhn commented Jun 4, 2024

The tutorial is almost done.

@zivkovicmilos I have two questions:

  1. I would like this tutorial to live in the Gno Tooling section, either under a subsection on gnokey, or simply replacing the current file in that section. The current file is basically slightly expanded help output. WDYT?
  2. If we keep this tutorial in the Getting Started section, I think covering multisig is a bit too much, since people getting started will probably not look to make a multisig.

@leohhhn
Copy link
Contributor Author

leohhhn commented Jun 4, 2024

Also, I will leave the verify functionality out of this tutorial until we figure out this issue.

@leohhhn leohhhn added the 📖 documentation Improvements or additions to documentation label Jun 5, 2024
docs/getting-started/local-setup/creating-a-keypair.md Outdated Show resolved Hide resolved
docs/gno-tooling/cli/gnokey/full-security-tx.md Outdated Show resolved Hide resolved
docs/gno-tooling/cli/gnokey/full-security-tx.md Outdated Show resolved Hide resolved
docs/gno-tooling/cli/gnokey/full-security-tx.md Outdated Show resolved Hide resolved
docs/gno-tooling/cli/gnokey/full-security-tx.md Outdated Show resolved Hide resolved
docs/gno-tooling/cli/gnokey/full-security-tx.md Outdated Show resolved Hide resolved
@deelawn deelawn dismissed zivkovicmilos’s stale review September 5, 2024 18:51

OOO and need to merge this after months

@deelawn deelawn merged commit fc51fc5 into gnolang:master Sep 5, 2024
55 checks passed
@leohhhn leohhhn deleted the docs/gnokey-tutorial branch September 9, 2024 13:29
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
Status: Done
Development

Successfully merging this pull request may close these issues.

[Docs] gnokey command in Getting Started
6 participants