Skip to content

Surface CLI install instructions on the CLI landing pages - #2834

Open
kaankacar wants to merge 1 commit into
mainfrom
docs-agent/1791-cli-install-position
Open

Surface CLI install instructions on the CLI landing pages#2834
kaankacar wants to merge 1 commit into
mainfrom
docs-agent/1791-cli-install-position

Conversation

@kaankacar

Copy link
Copy Markdown
Contributor

🤖 Automated message from Kaan's Automated Triage Bot.

Refs #1791

The two CLI landing pages did not show how to install the CLI. docs/tools/cli/README.mdx now opens with an Install section that holds the install script one-liner and links install-cli.mdx for the other methods. The Cookbook index links the install page too, because /docs/build/guides/cli, the Google entry point in the issue, redirects there.

The PR says "Refs", not "Closes". /docs/tools/cli/stellar-cli is generated from the upstream FULL_HELP_DOCS.md, so an install pointer on that page needs a change to scripts/stellar_cli.mjs.

docs/tools/cli/cookbook/README.mdx survives the build: the upstream cookbook/ directory that cpSync copies over it holds 19 guide files and no README.mdx.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds CLI installation guidance to key landing pages.

Changes:

  • Adds the install script and links to alternative methods.
  • Links the Cookbook landing page to installation instructions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/tools/cli/README.mdx Adds installation and learning resources.
docs/tools/cli/cookbook/README.mdx Adds an installation-page link.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions github-actions Bot added the preview Preview builds for PRs by SDF employees. label Sep 8, 2026
@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

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

Labels

preview Preview builds for PRs by SDF employees.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants