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

wallets: Fix and improve links and descriptions #1152

Merged
merged 1 commit into from
Dec 4, 2023

Conversation

xaur
Copy link
Contributor

@xaur xaur commented Nov 6, 2023

wallets: Fix and improve links and descriptions

  • DEX: Fix unintended removal of the Website link to
    https://dex.decred.org (fix Add back the link to dex.decred.org #1147).

  • DEX: Add "Setup guide" link. That wiki page is often recommended to
    newcomers so suggest it as the entry guide here.

  • Decrediton: Add "Downloads" to the first link's label because it has
    extra options not listed in the quick/popular direct links.

  • Decrediton: Remove confusing "GitHub" link. It should have been called
    "Source code" but the other panels don't link to source code, and
    the Decrediton panel is overcrowded compared to the others.

  • CLI: Change "GitHub" link to "Download installer".

  • CLI: Add "Installer guide" link which explains what will be installed
    and where.

  • CLI: Change last link to "Release notes + standalone" to indicate that
    it is a second download/install option.

  • Use plural "Downloads" consistently.

  • en.json: Update English strings to reflect the above changes and better
    introduce the apps. Only tweaking a few strings in this commit. More
    work could be done in future commits to help users choose between all
    the options.

src/data/wallets/wallets.yml Outdated Show resolved Hide resolved
- title: GitHub
- title: Downloads and release notes
url: https://github.com/decred/decred-binaries/releases/tag/v1.8.1
- title: Installer (advanced)
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure about this. We have previously considered the loose binaries to be the advanced version because they need more work to configure. dcrinstall was the laymans version because it handles hash verification and config setup automatically.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry I forgot to add context. I got the idea of de-prioritizing dcrinstall from this chat in #dex:

dcrinstall needs a dedicated maintainer or else needs to be deprecated.

tbh i think dcrinstall has out-lived its usefulness. It was the correct tool for the job at the time, but now that we have decrediton and dex its kind of pointless

it was originally built to make CLI tools accessible for non-technical people back when we didnt have a decent GUI wallet

like 90% of the support burden was just helping people to place and modify dcrd/dcrwallet config files, and dcrinstall fixed that

but in 2023 the kind of people who need that kind of support should prob just use decrediton instead

It happened after someone installed an outdated version of dexc via dcrinstall. I figured those are good points that we can reflect on Wallets.

Also its release page has no release notes or instructions what to do with the files, not even a link to decred-binaries. So we'd be sending users to no-information page as a recommended option. OTOH decred-binaries links to dcrinstall for installing the CLI tools. Hash and sig verification needs to be done for dcrinstall files too (chicken and egg problem).

That said I can swap the recommended/advanced links back to not block on this and discuss it separately.

Copy link
Member

Choose a reason for hiding this comment

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

It isn't included in the release notes, but documentation for dcrinstall does exist here and here .

I think this needs a wider discussion, could you please pull this change out of the PR so we can merge the rest of the improvements?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah let's get more feedback on it. I'll do that in a separate PR.

Changed:

  • Returned the order to put dcrinstall first.
  • Added CLI guide link. It is a good entry point that explains what will be installed and where.
  • Changed last link to "Release notes + standalone" to hint that it's also a download option (I always use decred-binaries personally).
  • Updated en.json text.

Had to squash to update the commit and PR messages too. Changes since last iteration here.

I wonder if the CLI panel is overloaded now?

transifex_catalogs/en.json Outdated Show resolved Hide resolved
@xaur
Copy link
Contributor Author

xaur commented Nov 10, 2023

Rebased and updated commit message

- DEX: Fix unintended removal of the Website link to
  https://dex.decred.org (fix decred#1147).

- DEX: Add "Setup guide" link. That wiki page is often recommended to
  newcomers so suggest it as the entry guide here.

- Decrediton: Add "Downloads" to the first link's label because it has
  extra options not listed in the quick/popular direct links.

- Decrediton: Remove confusing "GitHub" link. It should have been called
  "Source code" but the other panels don't link to source code, and
  the Decrediton panel is overcrowded compared to the others.

- CLI: Change "GitHub" link to "Download installer".

- CLI: Add "Installer guide" link which explains what will be installed
  and where.

- CLI: Change last link to "Release notes + standalone" to indicate that
  it is a second download/install option.

- Use plural "Downloads" consistently.

- en.json: Update English strings to reflect the above changes and better
  introduce the apps. Only tweaking a few strings in this commit. More
  work could be done in future commits to help users choose between all
  the options.
@xaur
Copy link
Contributor Author

xaur commented Nov 14, 2023

The price to better explain app choices and links is it got a bit more busy.

Before:

1 before

After (hacked HTML):

2 after

Copy link
Member

@jholdstock jholdstock left a comment

Choose a reason for hiding this comment

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

lgtm

@jholdstock jholdstock merged commit ffc2548 into decred:master Dec 4, 2023
2 checks passed
@xaur xaur deleted the walletslinks branch March 18, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add back the link to dex.decred.org
3 participants