Skip to content

Restructure the stellar-cli docs so that install instructions are better positioned #1791

Description

@leighmcculloch

I think we need to restructure the stellar-cli docs so that the install instructions are better positioned.

When searching with Google for "stellar-cli", the first result is:

https://developers.stellar.org/docs/build/guides/cli

Image

That page doesn't direct a user for instructions for how to install the stellar-cli. For example:

Image

As a developer myself I find that when I'm searching for developer tooling most often I'm seeking that one-liner install command to get going.

The CLI docs exist at these locations:
https://developers.stellar.org/docs/tools/cli
https://developers.stellar.org/docs/tools/cli/stellar-cli
https://developers.stellar.org/docs/build/guides/cli 👈🏻 Google Search entry point
https://developers.stellar.org/docs/tools/cli/install-cli
https://developers.stellar.org/docs/build/smart-contracts/getting-started/setup#install-the-stellar-cli

Because of how search engines prioritise results developers can end up at any of these pages as an entry point into discovering the stellar-cli for the first time, but only some of them provide install instructions. Even if they end up at the tools/cli url, they won't see install instructions as a first point of contact.

cc @stellar/devx

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    dev-xdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    • Status
      No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions