Skip to content

Commit

Permalink
Improve docs on testing
Browse files Browse the repository at this point in the history
  • Loading branch information
d0cd committed Feb 17, 2025
1 parent bebcaee commit 04645cd
Show file tree
Hide file tree
Showing 14 changed files with 587 additions and 97 deletions.
96 changes: 0 additions & 96 deletions archive/src/learn/zkcloud/snarkos_dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,99 +129,3 @@ snarkos developer scan [OPTIONS] --endpoint <ENDPOINT>
```


### 3. Local Devnet

#### 3.1 Install `tmux`

To run a local devnet with the script, start by installing `tmux`.

<details><summary>macOS</summary>

To install `tmux` on macOS, you can use the `Homebrew` package manager.
If you haven't installed `Homebrew` yet, you can find instructions at [their website](https://brew.sh/).
```bash
# Once Homebrew is installed, run:
brew install tmux
```

</details>

<details><summary>Ubuntu</summary>

On Ubuntu and other Debian-based systems, you can use the `apt` package manager:
```bash
sudo apt update
sudo apt install tmux
```

</details>

<details><summary>Windows</summary>

There are a couple of ways to use `tmux` on Windows:

### Using Windows Subsystem for Linux (WSL)

1. First, install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install).
2. Once WSL is set up and you have a Linux distribution installed (e.g., Ubuntu), open your WSL terminal and install `tmux` as you would on a native Linux system:
```bash
sudo apt update
sudo apt install tmux
```

</details>

#### 3.2 Start a Local Devnet

To start a local devnet, run:
```bash
./devnet.sh
```
Follow the instructions in the terminal to start the devnet.

#### 3.3 View a Local Devnet

#### Switch Nodes (forward)

To toggle to the next node in a local devnet, run:
```bash
Ctrl+b n
```

#### Switch Nodes (backwards)

To toggle to the previous node in a local devnet, run:
```bash
Ctrl+b p
```

#### Scroll Node

To scroll easily run:
```bash
Ctrl+b [
```
#### Select a Node (choose-tree)
To select a node in a local devnet, run:
```bash
Ctrl+b w
```
To quit scroll press `q`
#### Select a Node (manually)
To select a node manually in a local devnet, run:
```bash
Ctrl+b :select-window -t {NODE_ID}
```
#### 3.4 Stop a Local Devnet
To stop a local devnet, run:
```bash
Ctrl+b :kill-session
```
Then, press `Enter`.
2 changes: 2 additions & 0 deletions documentation/cli/01_deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ title: Deploy Your Programs
sidebar_label: Deploy
---

<!--TODO:-->

Coming soon!
2 changes: 2 additions & 0 deletions documentation/cli/02_executing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ title: Run Your Programs
sidebar_label: Execute
---

<!--TODO:-->

Coming soon!
1 change: 1 addition & 0 deletions documentation/cli/04_dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ id: dependencies
title: Dependency Management
sidebar_label: Dependency Management
---
<!--TODO:-->

Coming soon!
2 changes: 2 additions & 0 deletions documentation/cli/05_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,7 @@ title: Retrieving Network Metadata and State
sidebar_label: Querying the Network
---

<!--TODO:-->

Coming soon!

11 changes: 11 additions & 0 deletions documentation/concepts/00_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: overview
title: Overview
sidebar_label: Overview
---

There is a lot to learn about Leo! To help tame the complexity, we've put together some explainers and tutorials around some of the concepts and tools in Leo.

- [**The Asynchronous Programming Model**](01_async.md) - Coming soon!

- [**Debuggin' Out**](./02_debuggin.md) - Learn how to use Leo's interactive debugger.
4 changes: 3 additions & 1 deletion documentation/concepts/01_async.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
id: async
title: The Async Programming Model
title: The Asynchronous Programming Model
sidebar_label: Async Model
---

<!--TODO:-->

Coming soon!
Loading

0 comments on commit 04645cd

Please sign in to comment.