Skip to content

Open source AI coding agent. Designed for large projects and real world tasks.

docs touchups

Dane Schneider2cdca2909743
diff --git a/docs/docs/core-concepts/execution-and-debugging.md b/docs/docs/core-concepts/execution-and-debugging.md
index 5d4b2766..d047b210 100644
--- a/docs/docs/core-concepts/execution-and-debugging.md
+++ b/docs/docs/core-concepts/execution-and-debugging.md
@@ -11,7 +11,7 @@ Plandex v2 includes command execution and automated debugging capabilities that
During a plan, apart from making changes to files, Plandex can write to a special path, `_apply.sh`, with any commands required to complete the plan. This commonly includes installing dependencies, running tests, building and running code, starting servers, and so on.
-Commands accumulate in the sandbox just like [pending changes to files](./reviewing-changes.md#pending-changes). If execution fails, you can roll back changes and optionally send the output to the model for automated debugging and retries.
+Commands accumulate in the sandbox just like [pending changes to files](./reviewing-changes.md). If execution fails, you can roll back changes and optionally send the output to the model for automated debugging and retries.
While Plandex will attempt to automatically infer relevant commands to run, it also tries not to overdo it. It generally won't, for example, run a test suite unless you've specifically asked it to, since it may not be desirable after every change. It tries to only run what's strictly necessary, to make local project-level changes instead of global system-wide changes, to check existing dependencies before installing, to write idempotent commands, to avoid hiding output or asking for user input, and to recover gracefully from failures.
diff --git a/docs/docs/hosting/self-hosting/local-mode-quickstart.md b/docs/docs/hosting/self-hosting/local-mode-quickstart.md
index cc9fa64b..54930a06 100644
--- a/docs/docs/hosting/self-hosting/local-mode-quickstart.md
+++ b/docs/docs/hosting/self-hosting/local-mode-quickstart.md
@@ -7,8 +7,6 @@ sidebar_label: Local Mode Quickstart
Plandex is open source and uses a client-server architecture. The server can be self-hosted. You can either run it locally or on a cloud server that you control. To run it on a cloud server, go to [Advanced Self-Hosting](./advanced-self-hosting) section. To run it locally, keep reading below.
-**Note for v1 users:** Both the Plandex v2 server and CLI are designed to run *separately* from v1. It's not an in-place upgrade. [More details here.](../../upgrading-v1-to-v2.md)
-
## Local Mode Quickstart
The quickstart requires git, docker, and docker-compose. It's designed for local use with a single user.
@@ -53,5 +51,4 @@ export OPENAI_API_KEY=<your-openai-api-key>
plandex
```
-You're ready to start building!
-
+You're ready to start building!
\ No newline at end of file
diff --git a/docs/docs/install.md b/docs/docs/install.md
index b46757ca..6bf8dc24 100644
--- a/docs/docs/install.md
+++ b/docs/docs/install.md
@@ -11,8 +11,6 @@ sidebar_label: Install
curl -sL https://plandex.ai/install.sh | bash
```
-**Note for v1 users:** when you install the Plandex v2 CLI with the quick install script, it will rename your existing `plandex` command to `plandex1` (and the `pdx` alias to `pdx1`). Plandex v2 is designed to run *separately* from v1 rather than upgrading in place. [More details here.](./upgrading-v1-to-v2.md)
-
## Manual install
Grab the appropriate binary for your platform from the latest [release](https://github.com/plandex-ai/plandex/releases) and put it somewhere in your `PATH`.
@@ -32,3 +30,7 @@ mv plandex /usr/local/bin # adapt as needed for your system
Windows is supported via [WSL](https://learn.microsoft.com/en-us/windows/wsl/about).
Plandex only works correctly in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell.
+
+## Upgrading from v1 to v2
+
+When you install the Plandex v2 CLI with the quick install script, it will rename your existing `plandex` command to `plandex1` (and the `pdx` alias to `pdx1`). Plandex v2 is designed to run *separately* from v1 rather than upgrading in place. [More details here.](./upgrading-v1-to-v2.md)
\ No newline at end of file
diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md
index f474a78d..e915348d 100644
--- a/docs/docs/quick-start.md
+++ b/docs/docs/quick-start.md
@@ -11,8 +11,6 @@ sidebar_label: Quickstart
curl -sL https://plandex.ai/install.sh | bash
```
-**Note for v1 users:** when you install the Plandex v2 CLI with the quick install script, it will rename your existing `plandex` command to `plandex1` (and the `pdx` alias to `pdx1`). Plandex v2 is designed to run *separately* from v1 rather than upgrading in place. [More details here.](./upgrading-v1-to-v2.md)
-
[Click here for more installation options.](./install.md)
Note that Windows is supported via [WSL](https://learn.microsoft.com/en-us/windows/wsl/about). Plandex only works correctly on Windows in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell.