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

Review of README & onboarding #1694

Closed
zramsay opened this issue Dec 4, 2018 · 0 comments · Fixed by #1801
Closed

Review of README & onboarding #1694

zramsay opened this issue Dec 4, 2018 · 0 comments · Fixed by #1801
Assignees
Labels
documentation 📚 Issues that require documentation either on the repository or in the Cosmos Docs high priority ❗ user-feedback Voyager feedback from users

Comments

@zramsay
Copy link
Contributor

zramsay commented Dec 4, 2018

for #1650, these are some notes about onboarding, mostly WRT to the README

General Points:

  • readme is somewhat overwhelming; too many emojis & details that would be better in seperate docs
  • it isn't clear the distinction between what a user and developer should do ... link to download binary isn't top and centre (when it should be, I think, most people coming to this repo probably want to only do just that
  • again blurring the line between user and dev, the readme suggests even a user needs to install docker
  • yarn is explained after a handful of commands, same with the git clone
  • whats up with versioning? 0.10.4 then 0.8001.1 ?
  • the list of environment variable should be moved into a seperate doc and better explained.

Summary:

  • the README can be significantly re-organized, and some structure to added to developer / user documentation

Specific Points:

  • readme says "No Active Testnet, must run a local node to test Voyager out" but after downloading binary, starting the app, and going through the first few steps, the bottom left icon tell me i'm connected to 8001
  • it's not clear how to connect to a local testnet ... i tried various approaches, the most promising being "Offline Mode" from Settings, which prompts me to create a default account (the purpose of this account is unclear, ive already created on to start my localnet) ... and don't I have to run a local node for Voyager to connect to? shouldn't Voyager tell me its trying to connect to a local node and failing? Turns out (I think) that offline mode is really just "we pre-loaded some stuff for you, there isn't actually a running blockchain" whereas the README would lead one to believe that "Offline mode" is meant for testing using a local node. This should be documented somewhere.
  • I'm not able to change "Node IP" in either Offline Mode or Live Testnet, why not? I want to select the seed to connect to. How do I connect to a different testnet if I can't change the NodeIP?

Summary:

  • there's inconsistencies between the readme and the app which make navigating / using it confusing & i wasn't able to test all the features. Perhaps I'm missing a critical feature / option but I couldn't connect Voyager to a local gaiad chain.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📚 Issues that require documentation either on the repository or in the Cosmos Docs high priority ❗ user-feedback Voyager feedback from users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants