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

Remove incorrect stellar-cli instructions #1107

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

leighmcculloch
Copy link
Member

@leighmcculloch leighmcculloch commented Nov 30, 2024

What

Remove incorrect stellar-cli instructions.

Why

The instructions say to use the cargo install command to install from the main branch, but the command won't do that, it'll install the latest released version. We already show a similar command above that for how to install the latest version (with the version specified), so we don't need to show it a second time without the version specified.

I also don't think we should promote how folks can install from the main branch. The main branch is unreleased and unstable. If folks really want to they can go and install from the main branch, but we don't need to place it front and centre as a recommended way to go.

The idea of building the main branch came about when the cli was releasing too infrequently. We're trying to, and are, releasing more frequently now.

@stellar-jenkins
Copy link

1 similar comment
@stellar-jenkins
Copy link

@leighmcculloch leighmcculloch requested a review from fnando December 2, 2024 03:14
@leighmcculloch leighmcculloch marked this pull request as ready for review December 2, 2024 03:14
@fnando
Copy link
Member

fnando commented Dec 2, 2024

Instead of removing the instructions, should we fix them instead by adding --git?

@leighmcculloch
Copy link
Member Author

Instead of removing the instructions, should we fix them instead by adding --git?

I don't think so. These docs are communicating the primary ways we want devs to use the tooling. I don't think we really want the majority of users running unreleased CLIs. Instead we should be releasing so often no one would need to use the unreleased CLIs.

@leighmcculloch leighmcculloch merged commit bedbee2 into main Dec 2, 2024
2 checks passed
@leighmcculloch leighmcculloch deleted the boilerworks-clubfellow branch December 2, 2024 22:39
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.

3 participants