Adding Uninstall Docs #3092
Adding Uninstall Docs #3092
Conversation
| @@ -31,6 +31,10 @@ In this section, we will walk through the process of installing Starknet Foundry | |||
| * [Linux and macOS](#linux-and-macos-2) | |||
| * [Windows](#windows-2) | |||
| * [How to build Starknet Foundry from source code](#how-to-build-starknet-foundry-from-source-code) | |||
| * [Uninstalling](#uninstalling) | |||
| * [Linux and MacOS](#linux--macos) | |||
There was a problem hiding this comment.
nit: For consistency 😅 :
| * [Linux and MacOS](#linux--macos) | |
| * [Linux and macOS](#linux--macos) |
There was a problem hiding this comment.
Uninstallation guide should be a separate markdown file, listed in SUMMARY.md (same as for installation). Please restructure it.
| @@ -441,3 +445,91 @@ the [source code](https://github.com/foundry-rs/starknet-foundry) as follows: | |||
| 2. Run `cd starknet-foundry && cargo build --release`. This will create a `target` directory. | |||
| 3. Move the `target` directory to the desired location (e.g. `~/.starknet-foundry`). | |||
| 4. Add `DESIRED_LOCATION/target/release/` to your `PATH`. | |||
|
|
|||
| # Uninstalling | |||
There was a problem hiding this comment.
Let's use noun, same as we do for other sections.
| First, remove the plugin from `asdf`: | ||
| ```bash |
There was a problem hiding this comment.
nit: Spacing (applies to all code blocks below):
| First, remove the plugin from `asdf`: | |
| ```bash | |
| First, remove the plugin from `asdf`: | |
| ```bash |
| @@ -441,3 +445,91 @@ the [source code](https://github.com/foundry-rs/starknet-foundry) as follows: | |||
| 2. Run `cd starknet-foundry && cargo build --release`. This will create a `target` directory. | |||
| 3. Move the `target` directory to the desired location (e.g. `~/.starknet-foundry`). | |||
| 4. Add `DESIRED_LOCATION/target/release/` to your `PATH`. | |||
|
|
|||
| # Uninstalling | |||
| This section will guide you in how to uninstall Starknet Foundry. | |||
There was a problem hiding this comment.
This line is redundant, reword or remove please.
| @@ -441,3 +445,91 @@ the [source code](https://github.com/foundry-rs/starknet-foundry) as follows: | |||
| 2. Run `cd starknet-foundry && cargo build --release`. This will create a `target` directory. | |||
| 3. Move the `target` directory to the desired location (e.g. `~/.starknet-foundry`). | |||
| 4. Add `DESIRED_LOCATION/target/release/` to your `PATH`. | |||
|
|
|||
| # Uninstalling | |||
There was a problem hiding this comment.
I think this could be separate file, we could nest it under Installation in SUMMARY.md
Then just add a link to installation section to it as well.
| To ensure complete removal, delete Scarb-related files from the | ||
| asdf installation directory: | ||
| ```bash | ||
| rm -rf ~/.asdf/installs/scarb | ||
| rm -rf ~/.asdf/plugins/scarb | ||
| ``` |
There was a problem hiding this comment.
Don't think we should maintain docs like this. If anywhere this should be in scarb docs.
| This section will guide you in how to uninstall Starknet Foundry. | ||
|
|
||
| ## Linux & MacOS | ||
| If you installed **Starknet Foundry** using `asdf`, follow these steps to remove it. |
There was a problem hiding this comment.
We don't provide any other installation instructions anyway. I'd just say something along the lines of "use these instructions to uninstall".
| If you installed **Starknet Foundry** using `asdf`, follow these steps to remove it. | ||
|
|
||
| ### Starknet-Foundry | ||
| First, remove the plugin from `asdf`: |
There was a problem hiding this comment.
Let's link this https://asdf-vm.com/manage/plugins.html#remove and say for details reference this link
Adding uninstalling guides for Starknet Foundry and Scarb for Linux, MacOS and Windows
Closes #
Issue #2768
Introduced changes
Files changes are the Install docs, where I added the uninstalling guide. In addition, the table of content has been
modified to align with the changes.
Checklist
CHANGELOG.md