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 instructions for gnofaucet #1460

Closed
wants to merge 4 commits into from

Conversation

iuricmp
Copy link
Contributor

@iuricmp iuricmp commented Dec 18, 2023

This PR adds a small instruction to allow users run GnoFaucet connected with local gnokey.

refs: leohhhn/gnoland_zero_to_hero#1

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.

@iuricmp iuricmp requested a review from a team as a code owner December 18, 2023 23:30
@moul moul requested a review from a team December 20, 2023 11:20
@leohhhn leohhhn added the 📖 documentation Improvements or additions to documentation label Dec 20, 2023
@leohhhn leohhhn self-requested a review December 20, 2023 14:46
@@ -42,6 +42,20 @@ After the chain is up and running locally, you can start the faucet by running t
gnofaucet serve --chain-id dev MyKey
```

:::danger Key MyKey not found
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @iuricmp, thanks for pointing this out, you were a bit ahead of me on documenting this :)

While I think it is super useful to document common errors, I think doing it this way is a little bit cluttering - this would not be scalable if we keep on adding common errors.

How I would go about documenting this:

  1. accurately define the usages of gnokey and gnofaucet, ie, document the --home argument in both (afaik it's missing in the options list),
  2. mention in this file that gnofaucet relies on the gnokey home dir to look for keys (similar to what you did, just not under ::danger::, but as normal text)
  3. further down the line, have a common errors/issues/faq page for docs, which would be an organized place to dump these things.

Down the line, the plan is to have documentation for tools be auto-exported from the --help option of the tool, allowing for in-sync tool and docs development.

I suggest you do 1. & 2., and we can discuss 3 :)

Thanks!

@iuricmp
Copy link
Contributor Author

iuricmp commented Jan 9, 2024

I'm closing this PR since it seems that this version of gnofaucet will be discontinued in favor of https://github.com/gnolang/faucet.

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
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants