From d050a3f77c5b786bb5bccf12b6ce20db585547a2 Mon Sep 17 00:00:00 2001
From: Keith Webber <townie@users.noreply.github.com>
Date: Tue, 11 Feb 2025 19:43:52 -0800
Subject: [PATCH] docs: Provide feedback when cloning submodules (#9448)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

<!-- Clearly explain the need for these changes: -->

### Changes 🏗️
Added `--progress` to the submodule update, so that cloning progress can
be tracked and does not appear to hang.
<!-- Concisely describe all of the changes made in this pull request:
-->

### Checklist 📋

#### For code changes:
- [x] No code change, just docs.


<details>
  <summary>Example test plan</summary>

  - [ ] Create from scratch and execute an agent with at least 3 blocks
- [ ] Import an agent from file upload, and confirm it executes
correctly
  - [ ] Upload agent to marketplace
- [ ] Import an agent from marketplace and confirm it executes correctly
  - [ ] Edit an agent from monitor, and confirm it executes correctly
</details>

#### For configuration changes:
- [x] No configuration change, just docs.


<details>
  <summary> Provide feedback when cloning submodules </summary>

  -  now updating submodules shows the cloning repo's progress

</details>

Co-authored-by: Your Name <you@example.com>
---
 autogpt_platform/README.md               | 2 +-
 docs/content/platform/getting-started.md | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/autogpt_platform/README.md b/autogpt_platform/README.md
index 64e61e880c..3fbb6519b1 100644
--- a/autogpt_platform/README.md
+++ b/autogpt_platform/README.md
@@ -22,7 +22,7 @@ To run the AutoGPT Platform, follow these steps:
 
 2. Run the following command:
    ```
-   git submodule update --init --recursive
+   git submodule update --init --recursive --progress
    ```
    This command will initialize and update the submodules in the repository. The `supabase` folder will be cloned to the root directory.
 
diff --git a/docs/content/platform/getting-started.md b/docs/content/platform/getting-started.md
index 3613d014f5..7ec256c9d4 100644
--- a/docs/content/platform/getting-started.md
+++ b/docs/content/platform/getting-started.md
@@ -77,7 +77,7 @@ To run the backend services, follow these steps:
 
 * Within the repository, clone the submodules and navigate to the `autogpt_platform` directory:
   ```bash
-   git submodule update --init --recursive
+   git submodule update --init --recursive --progress
    cd autogpt_platform
   ```
   This command will initialize and update the submodules in the repository. The `supabase` folder will be cloned to the root directory.