Skip to content

Commit 73bb5c4

Browse files
ReecepbcupsReecepbcups
authored
fix: tab docs, new version (#252)
* feat: new tabs * bump: spawn v0.50.10 * link check * minor modify
1 parent 0f03039 commit 73bb5c4

File tree

6 files changed

+127
-123
lines changed

6 files changed

+127
-123
lines changed

Diff for: ‎README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@ Spawn is the easiest way to build, maintain and scale a Cosmos SDK blockchain. S
1818

1919
If you do not have [`go 1.22+`](https://go.dev/doc/install), [`Docker`](https://docs.docker.com/get-docker/), or [`git`](https://git-scm.com/) installed, follow the instructions below.
2020

21-
* [MacOS](./docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md#macos)
22-
* [Windows](./docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md#windows)
23-
* [Ubuntu](./docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md#linux-ubuntu)
21+
* [MacOS, Windows, and Ubuntu Setup](./docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md)
2422

2523
### Install Spawn
2624

2725
```bash
2826
# Download the the Spawn repository
29-
git clone https://github.com/rollchains/spawn.git --depth=1 --branch v0.50.9
27+
git clone https://github.com/rollchains/spawn.git --depth=1 --branch v0.50.10
3028
cd spawn
3129

3230
# Install Spawn
@@ -38,11 +36,11 @@ make get-localic
3836
# Attempt to run a command
3937
spawn help
4038

41-
# Potential workaround if spawn is immediately killed when attempting run "spawn help" on a m* macbook.
39+
# Potential workaround if spawn is immediately killed when attempting run "spawn help" on a m* macbook.
4240
# This may happen because of an xcode16 update.
43-
# To work around this as a temporary measure please change this line in the Make file.
41+
# To work around this as a temporary measure please change this line in the Make file.
4442
LD_FLAGS = -X main.SpawnVersion=$(VERSION)
45-
# to
43+
# to
4644
LD_FLAGS = -X main.SpawnVersion=$(VERSION) -s -w
4745

4846

Diff for: ‎docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md

+117-111
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sidebar_position: 1
55
slug: /install/system-setup
66
---
77

8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
810

911
# Overview
1012

@@ -22,114 +24,118 @@ Before you can install and interact with spawn, you must have the following core
2224

2325
If you do not have these components installed, follow the instructions below to install them.
2426

25-
## Windows
26-
27-
```bash
28-
# Install WSL in powershell
29-
wsl --install
30-
Restart-Computer
31-
32-
# Setup WSL Ubuntu Image
33-
wsl.exe --install Ubuntu-24.04
34-
35-
# Open wsl instance
36-
wsl
37-
38-
# update and add snap if not already installed
39-
sudo apt update && sudo apt install snapd
40-
41-
# Install Go (Snap)
42-
sudo snap install go --channel=1.23/stable --classic
43-
44-
# Install Base
45-
sudo apt install make gcc git jq wget
46-
47-
# Install github-cli
48-
sudo snap install gh
49-
50-
# Install docker
51-
https://docs.docker.com/desktop/wsl/#turn-on-docker-desktop-wsl-2
52-
# or snap:
53-
sudo snap install docker
54-
55-
# Fix versioning for interaction of commands
56-
sudo chmod 666 /var/run/docker.sock
57-
58-
# Setup base git config
59-
git config --global user.email "[email protected]"
60-
git config --global user.name "Your Name"
61-
```
62-
63-
64-
## MacOS
65-
66-
```bash
67-
# Base
68-
brew install make
69-
brew install gcc
70-
brew install wget
71-
brew install jq
72-
73-
# Github CLI - https://github.com/cli/cli
74-
brew install gh
75-
gh auth login
76-
77-
# Golang
78-
brew install go
79-
80-
# Docker
81-
brew install --cask docker
82-
open -a Docker # start docker desktop
83-
# settings -> General -> Start Docker Desktop when you sign in to your computer
84-
# Apply & Restart
85-
86-
# Setup base git config
87-
git config --global user.email "[email protected]"
88-
git config --global user.name "Your Name"
89-
```
90-
91-
92-
## Linux (Ubuntu)
93-
94-
```bash
95-
# Base
96-
sudo apt install make gcc git jq wget
97-
98-
# (optional) Github CLI - https://github.com/cli/cli
99-
curl -sS https://webi.sh/gh | sh
100-
gh auth login
101-
102-
# Golang
103-
GO_VERSION=1.23.0
104-
wget https://go.dev/dl/go$GO_VERSION.linux-amd64.tar.gz
105-
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go$GO_VERSION.linux-amd64.tar.gz
106-
107-
# Docker
108-
sudo apt -y install docker.io
109-
110-
# Setup base git config
111-
git config --global user.email "[email protected]"
112-
git config --global user.name "Your Name"
113-
```
114-
115-
## CosmWasm
116-
117-
Some tutorials require CosmWasm (Rust smart contracts) setup. This section is option, unless a tutorial is CosmWasm focused.
118-
CosmWasm requires [Rust](https://www.rust-lang.org/). You must have this installed as the contract will be built locally.
119-
120-
```bash
121-
# Install rust - https://www.rust-lang.org/tools/install
122-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
123-
124-
# Update shell env
125-
source $HOME/.cargo/env
126-
127-
# or Update if you have it
128-
rustup update
129-
130-
# Install other dependencies
131-
rustup target add wasm32-unknown-unknown
132-
133-
cargo install cargo-generate --features vendored-openssl
134-
cargo install cargo-run-script
135-
```
27+
## Install Dependencies
28+
29+
<Tabs defaultValue="macos">
30+
<TabItem value="macos" label="MacOS">
31+
```bash
32+
# Base
33+
brew install make
34+
brew install gcc
35+
brew install wget
36+
brew install jq
37+
38+
# Github CLI - https://github.com/cli/cli
39+
brew install gh
40+
gh auth login
41+
42+
# Golang
43+
brew install go
44+
45+
# Docker
46+
brew install --cask docker
47+
open -a Docker # start docker desktop
48+
# settings -> General -> Start Docker Desktop when you sign in to your computer
49+
# Apply & Restart
50+
51+
# Setup base git config
52+
git config --global user.email "[email protected]"
53+
git config --global user.name "Your Name"
54+
```
55+
</TabItem>
56+
57+
<TabItem value="windows" label="Windows (WSL)" default>
58+
```bash
59+
# Install WSL in powershell
60+
wsl --install
61+
Restart-Computer
62+
63+
# Setup WSL Ubuntu Image
64+
wsl.exe --install Ubuntu-24.04
65+
66+
# Open wsl instance
67+
wsl
68+
69+
# update and add snap if not already installed
70+
sudo apt update && sudo apt install snapd
71+
72+
# Install Go (Snap)
73+
sudo snap install go --channel=1.23/stable --classic
74+
75+
# Install Base
76+
sudo apt install make gcc git jq wget
77+
78+
# Install github-cli
79+
sudo snap install gh
80+
81+
# Install docker
82+
https://docs.docker.com/desktop/wsl/#turn-on-docker-desktop-wsl-2
83+
# or snap:
84+
sudo snap install docker
85+
86+
# Fix versioning for interaction of commands
87+
sudo chmod 666 /var/run/docker.sock
88+
89+
# Setup base git config
90+
git config --global user.email "[email protected]"
91+
git config --global user.name "Your Name"
92+
```
93+
</TabItem>
94+
95+
<TabItem value="ubuntu-linux" label="Linux (Ubuntu)">
96+
<!-- markdown-link-check-disable -->
97+
```bash
98+
# Base
99+
sudo apt install make gcc git jq wget
100+
101+
# (optional) Github CLI - https://github.com/cli/cli
102+
curl -sS https://webi.sh/gh | sh
103+
gh auth login
104+
105+
# Golang
106+
GO_VERSION=1.23.0
107+
wget https://go.dev/dl/go$GO_VERSION.linux-amd64.tar.gz
108+
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go$GO_VERSION.linux-amd64.tar.gz
109+
110+
# Docker
111+
sudo apt -y install docker.io
112+
113+
# Setup base git config
114+
git config --global user.email "[email protected]"
115+
git config --global user.name "Your Name"
116+
```
117+
</TabItem>
118+
<!-- markdown-link-check-enable -->
119+
120+
<TabItem value="cosmwasm-rust" label="CosmWasm (Rust)">
121+
Some tutorials require CosmWasm (Rust smart contracts) setup. This section is option, unless a tutorial is CosmWasm focused.
122+
123+
CosmWasm requires [Rust](https://www.rust-lang.org/). You must have this installed as the contract will be built locally.
124+
```bash
125+
# Install rust - https://www.rust-lang.org/tools/install
126+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
127+
128+
# Update shell env
129+
source $HOME/.cargo/env
130+
131+
# or Update if you have it
132+
rustup update
133+
134+
# Install other dependencies
135+
rustup target add wasm32-unknown-unknown
136+
137+
cargo install cargo-generate --features vendored-openssl
138+
cargo install cargo-run-script
139+
```
140+
</TabItem>
141+
</Tabs>

Diff for: ‎docs/versioned_docs/version-v0.50.x/01-setup/02-install-spawn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Install Spawn from source.
1919

2020
```bash
2121
# Install from latest source
22-
git clone https://github.com/rollchains/spawn.git --depth 1 --branch v0.50.9
22+
git clone https://github.com/rollchains/spawn.git --depth 1 --branch v0.50.10
2323

2424
# Change to this directory
2525
cd spawn

Diff for: ‎docs/versioned_docs/version-v0.50.x/02-build-your-application/09-ibc-cosmwasm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You will build a new IBC contract with [CosmWasm](https://cosmwasm.com), enablin
1212
## Prerequisites
1313
- [System Setup](../01-setup/01-system-setup.md)
1414
- [Install Spawn](../01-setup/02-install-spawn.md)
15-
- [Rust + CosmWasm](../01-setup/01-system-setup.md#cosmwasm)
15+
- [Rust + CosmWasm](../01-setup/01-system-setup.md)
1616

1717
## Setup the Chain
1818

Diff for: ‎docs/versioned_docs/version-v0.50.x/03-demos/04-cw-validator-reviews.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are easy ways to get validators in a cosmwasm smart contract. The goal of
1313
## Prerequisites
1414
- [System Setup](../01-setup/01-system-setup.md)
1515
- [Install Spawn](../01-setup/02-install-spawn.md)
16-
- [Rust + CosmWasm](../01-setup/01-system-setup.md#cosmwasm)
16+
- [Rust + CosmWasm](../01-setup/01-system-setup.md)
1717

1818
## Setup the Chain
1919

Diff for: ‎scripts/bump_docs.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# bumps docs versions for spawn
22

3-
OLD_VERSION=v0.50.8
4-
NEW_VERSION=v0.50.9
3+
OLD_VERSION=v0.50.9
4+
NEW_VERSION=v0.50.10
55

66
findAndReplace() {
77
find . -type f -name "$1" -not -path "*node_modules*" -exec sed -i "$2" {} \;

0 commit comments

Comments
 (0)