docs: Add Docker to Scaffold Stellar prerequisites#2267
docs: Add Docker to Scaffold Stellar prerequisites#2267
Conversation
Co-authored-by: oceans404 <91382964+oceans404@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates Scaffold Stellar documentation to explicitly list Docker as a prerequisite, preventing setup failures when stellar scaffold watch attempts to start a local network via the stellar/quickstart Docker image.
Changes:
- Added a Docker prerequisite row to the English Scaffold Stellar prerequisites table.
- Added the same Docker prerequisite row to both Spanish Scaffold Stellar doc locations.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/tools/scaffold-stellar.mdx | Adds Docker to prerequisites for running a local Stellar network via stellar/quickstart. |
| i18n/es/docusaurus-plugin-content-docs/current/tools/scaffold-stellar.mdx | Mirrors the Docker prerequisite addition in Spanish. |
| i18n/es/docusaurus-plugin-content-docs/current/tools/developer-tools/scaffold-stellar.mdx | Mirrors the Docker prerequisite addition in the alternate Spanish path. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | [Rust & Cargo](https://www.rust-lang.org/tools/install) | For writing and compiling smart contracts | `curl https://sh.rustup.rs -sSf \| sh` | | ||
| | [Node.js & npm](https://nodejs.org/) | For frontend development | Download from official site | | ||
| | [Stellar CLI](https://github.com/stellar/stellar-cli) | For building, deploying, and interacting with smart contracts | [`Link for the repo`](https://github.com/stellar/stellar-cli) | | ||
| | [Docker](https://www.docker.com/get-started/) | For running a local Stellar network via the `stellar/quickstart` image | [Download Docker Desktop](https://www.docker.com/products/docker-desktop/) | |
There was a problem hiding this comment.
The install link text is “Download Docker Desktop”, which is Mac/Windows-specific and can be misleading for Linux users (who typically install Docker Engine). Consider using a more general install label/link (e.g., “Get Docker” pointing to Docker’s official install docs) so the prerequisite applies across platforms.
| | [Docker](https://www.docker.com/get-started/) | For running a local Stellar network via the `stellar/quickstart` image | [Download Docker Desktop](https://www.docker.com/products/docker-desktop/) | | |
| | [Docker](https://www.docker.com/get-started/) | For running a local Stellar network via the `stellar/quickstart` image | [Get Docker](https://docs.docker.com/get-docker/) | |
| | [Rust & Cargo](https://www.rust-lang.org/tools/install) | Para escribir y compilar contratos inteligentes | `curl https://sh.rustup.rs -sSf \| sh` | | ||
| | [Node.js & npm](https://nodejs.org/) | Para el desarrollo frontend | Descarga desde el sitio oficial | | ||
| | [Stellar CLI](https://github.com/stellar/stellar-cli) | Para construir, desplegar e interactuar con contratos inteligentes | [`Link for the repo`](https://github.com/stellar/stellar-cli) | | ||
| | [Docker](https://www.docker.com/get-started/) | Para ejecutar una red Stellar local mediante la imagen `stellar/quickstart` | [Descargar Docker Desktop](https://www.docker.com/products/docker-desktop/) | |
There was a problem hiding this comment.
El texto del enlace de instalación dice “Descargar Docker Desktop”, lo cual es específico de Mac/Windows y puede confundir a usuarios de Linux (donde normalmente se instala Docker Engine). Considera usar un texto/enlace más general (p. ej., “Obtener Docker” con el enlace oficial de instalación) para que el prerrequisito aplique en todas las plataformas.
| | [Docker](https://www.docker.com/get-started/) | Para ejecutar una red Stellar local mediante la imagen `stellar/quickstart` | [Descargar Docker Desktop](https://www.docker.com/products/docker-desktop/) | | |
| | [Docker](https://www.docker.com/get-started/) | Para ejecutar una red Stellar local mediante la imagen `stellar/quickstart` | [Obtener Docker](https://docs.docker.com/get-docker/) | |
| | [Rust & Cargo](https://www.rust-lang.org/tools/install) | Para escribir y compilar contratos inteligentes | `curl https://sh.rustup.rs -sSf \| sh` | | ||
| | [Node.js & npm](https://nodejs.org/) | Para el desarrollo del frontend | Descargar desde el sitio oficial | | ||
| | [Stellar CLI](https://github.com/stellar/stellar-cli) | Para construir, desplegar e interactuar con contratos inteligentes | [`Link for the repo`](https://github.com/stellar/stellar-cli) | | ||
| | [Docker](https://www.docker.com/get-started/) | Para ejecutar una red Stellar local mediante la imagen `stellar/quickstart` | [Descargar Docker Desktop](https://www.docker.com/products/docker-desktop/) | |
There was a problem hiding this comment.
El texto del enlace de instalación dice “Descargar Docker Desktop”, lo cual es específico de Mac/Windows y puede confundir a usuarios de Linux (donde normalmente se instala Docker Engine). Considera usar un texto/enlace más general (p. ej., “Obtener Docker” con el enlace oficial de instalación) para que el prerrequisito aplique en todas las plataformas.
| | [Docker](https://www.docker.com/get-started/) | Para ejecutar una red Stellar local mediante la imagen `stellar/quickstart` | [Descargar Docker Desktop](https://www.docker.com/products/docker-desktop/) | | |
| | [Docker](https://www.docker.com/get-started/) | Para ejecutar una red Stellar local mediante la imagen `stellar/quickstart` | [Obtener Docker](https://docs.docker.com/get-docker/) | |
stellar scaffold watchrequires a running Docker daemon to spin up a local Stellar node via thestellar/quickstartimage, but Docker was absent from the prerequisites table — causing new users to hit an opaque connection error mid-setup.Changes
docs/tools/scaffold-stellar.mdx— Added Docker row to the prerequisites table (EN)i18n/es/.../tools/scaffold-stellar.mdx— Same addition in Spanishi18n/es/.../tools/developer-tools/scaffold-stellar.mdx— Same addition in the alternate Spanish locationNew row added across all three files:
stellar/quickstartimageOriginal prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.