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 mismatch with getting started page #173

Closed
PatrickAlphaC opened this issue Aug 13, 2022 · 7 comments · Fixed by #175
Closed

Docs mismatch with getting started page #173

PatrickAlphaC opened this issue Aug 13, 2022 · 7 comments · Fixed by #175

Comments

@PatrickAlphaC
Copy link

PatrickAlphaC commented Aug 13, 2022

The getting started docs page says to install with cargo, but the getting started page says to use cargo.

Can we please fix? Please point users to one canonical location.

@PatrickAlphaC
Copy link
Author

And then Try it says to download apps!

Can we please streamline this process.

@pinkforest
Copy link
Contributor

pinkforest commented Aug 13, 2022

Oh this needs to be:

cargo install radicle-cli --force --locked --git https://seed.alt-clients.radicle.xyz/radicle-cli.git

Fix here: #175

Thanks for reporting

@PatrickAlphaC
Copy link
Author

This is good, but it still doesn't address the issue. I'm saying developers are getting pulled into 3 different getting started places.

Which one is the right one? This needs to be clear across the website and docs.

@pinkforest
Copy link
Contributor

pinkforest commented Aug 13, 2022

Yeah we definitely should link to one canonical place as these will get easily out of date - I'll do some chasing up around.

FWIW - We may just do curl radup.sh that will greatly simplify this flow and is more future proof.

FWIW.2 - Probably also some BDD driven thing that automatically generates these and validates them in our CI as well

And thanks a lot for the feedback and persistence on this.

@PatrickAlphaC
Copy link
Author

Does it make sense to close this issue though? It hasn't been solved...

@PatrickAlphaC
Copy link
Author

Also:

cargo install radicle-cli --force --locked --git https://seed.alt-clients.radicle.xyz/radicle-cli.git

Is still not working for me.

@adam-hurwitz
Copy link

adam-hurwitz commented Feb 26, 2023

I posted a potentially similar issue where the Get started with Radicle site is not up-to-date with the Radicle CLI repository instructions.

See Get started with Radicle URL needs to be updated for Homebrew #280

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 a pull request may close this issue.

3 participants