Skip to content

Commit

Permalink
Docs: Inline "Bash" missing docs; change docs label on landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
Tasos Bitsios committed Jan 13, 2025
1 parent 3f94bf1 commit 98b2ce9
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 175 deletions.
19 changes: 11 additions & 8 deletions docs/src/content/docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,25 @@ To get started with NodeKit, copy-paste this command in your terminal:
curl -fsSL https://nodekit.run/install.sh | bash
```

<details>
<summary>Troubleshooting: Command 'curl' not found</summary>

<details><summary>Troubleshooting: Command 'curl' not found</summary>
If you get an error about the `curl` command not being found, you need to install the `curl` package.

On Ubuntu systems, you do this with:

```bash
sudo apt install -y curl
```
</details>
<details><summary>Troubleshooting: Command 'bash' not found</summary>
Some versions of Mac OS may not include the required `bash` executable that runs the installer.

If you get an error about `bash` not being available, please install bash on your system manually.

For Mac OS, a popular way to do this is to install [Homebrew](https://brew.sh/) and then install bash using:

```bash
brew install bash
```
</details>

This will detect your operating system and download the appropriate NodeKit executable to your local directory.
Expand All @@ -39,9 +47,4 @@ It will then immediately start the bootstrap process to get your Algorand node u

![Screenshot of a typical NodeKit installation process](/assets/nodekit-install.png)

:::note
**Did you encounter any errors?**
Check out the [Troubleshooting: Getting Started](/troubleshooting#getting-started-with-nodekit) section.
:::

Otherwise, read on for guidance on the bootstrapping process.
34 changes: 0 additions & 34 deletions docs/src/content/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,6 @@ next:

This page contains troubleshooting tips for common issues that you might run into. For additional support, please visit our [Discord channel](https://discord.com/channels/491256308461207573/807825288666939482).

## Getting started with NodeKit

:::note
This section outlines **common errors encountered** when executing the nodekit installation command.

**If you are looking for the installation instructions instead, they are located [here](/guides/10-getting-started).**
:::

### A nodekit file already exists in the current directory.

If you run the installer command more than once, you will see:

> ERROR: A nodekit file already exists in the current directory. Delete or rename it before installing.
If you want to fetch the latest version of nodekit, you can delete the existing file:

```bash
rm nodekit
```

And then run the [Getting Started](/guides/10-getting-started) command again.

### Command not found: bash

Some versions of Mac OS may not include the required `bash` executable that runs the installer.

If you get an error about `bash` not being available, please install bash on your system manually.

For Mac OS, a popular way to do this is to install [Homebrew](https://brew.sh/) and then install bash using:

```bash
brew install bash
```

## Bootstrapping the Algorand node

:::note
Expand Down
38 changes: 0 additions & 38 deletions docs/src/content/docs/troubleshooting/10-getting-started.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/src/content/docs/troubleshooting/20-bootstrap.md

This file was deleted.

This file was deleted.

2 changes: 1 addition & 1 deletion docs/src/pages/index.astro
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export const lang = "en";
<a
class="text-white/80 hover:text-[#BFBFF9]"
href="/guides/getting-started/"
>Documentation <Icon name="external" />
>Guides &amp; Documentation <Icon name="external" />
</a>
</div>
</div>
Expand Down

0 comments on commit 98b2ce9

Please sign in to comment.