Skip to content

Commit 336c798

Browse files
Merge pull request #1 from catalyst-network/docs/use-cases-user-first
docs: user-first use cases + simplified entry points
2 parents 86ca992 + e4cc58e commit 336c798

14 files changed

Lines changed: 411 additions & 23 deletions

File tree

site/docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ sidebar_position: 1
44

55
# Catalyst documentation hub
66

7-
This site is the single docs home for the Catalyst ecosystem.
7+
This is the public documentation hub for the Catalyst ecosystem.
88

99
## Choose your path
1010

11+
- **Everyday users**: start with **[Use cases (for everyone)](/docs/use-cases/send-money)** or **[Quickstart: use Catalyst apps](/docs/quickstarts/i-want-to-use-apps)**.
1112
- **Node operators**: start with **[Run a node](/docs/node-operators/run-a-node)**.
1213
- **Wallet users**: start with **[Use the wallet](/docs/quickstarts/i-want-to-use-the-wallet)**.
1314
- **dApp builders**: start with **[Deploy a contract](/docs/quickstarts/i-want-to-deploy-a-contract)**, then **[RPC: transaction lifecycle](/docs/rpc-reference/transaction-lifecycle)**.

site/docs/node-operators/install-build-binaries.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,28 @@ title: Install / build binaries
55

66
## You will need
77

8-
- Rust toolchain (for source builds)
9-
- Linux build dependencies (RocksDB, OpenSSL, toolchain)
8+
- Linux host
9+
- Either:
10+
- a **release binary** (no build), or
11+
- a Rust toolchain + build dependencies (source build)
1012

1113
## Steps
1214

13-
### Build from source (recommended)
15+
### Option A (recommended): download a release binary (no build)
16+
17+
If you want to run a node without compiling anything, use a published release.
18+
19+
1) Go to the releases page and download the latest `catalyst-cli` for Linux.
20+
21+
- Node repo releases: `https://github.com/catalyst-network/catalyst-node-rust/releases`
22+
23+
2) Verify the checksum (recommended) and install the binary somewhere stable, for example:
24+
25+
```bash
26+
sudo install -m 0755 catalyst-cli /usr/local/bin/catalyst-cli
27+
```
28+
29+
### Option B: build from source
1430

1531
```bash
1632
git clone https://github.com/catalyst-network/catalyst-node-rust

site/docs/node-operators/run-a-node.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,34 @@ Running a public node is operationally risky. Treat the host as production infra
1919

2020
- Linux host (Ubuntu/Debian examples below)
2121
- Open TCP **30333** (P2P). Open **8545** (RPC) only if you know what you’re doing (prefer IP allowlist / SSH tunnel).
22-
- Build deps (for source builds): `build-essential`, `clang`, `cmake`, `libssl-dev`
22+
- Either:
23+
- a **release binary** (no build), or
24+
- build deps (for source builds): `build-essential`, `clang`, `cmake`, `libssl-dev`
2325

2426
## Steps
2527

26-
### 1) Install build dependencies (Ubuntu/Debian)
28+
### 1) Get the binary (no-build or source-build)
29+
30+
Choose one:
31+
32+
- **No build (recommended)**: download a `catalyst-cli` release binary
33+
- `https://github.com/catalyst-network/catalyst-node-rust/releases`
34+
- **Build from source**: continue with the steps below
35+
36+
If you downloaded a binary, install it to a stable path used by systemd, for example:
37+
38+
```bash
39+
sudo install -m 0755 catalyst-cli /var/lib/catalyst/node/catalyst-cli
40+
```
41+
42+
### 2) Install build dependencies (Ubuntu/Debian) (source builds only)
2743

2844
```bash
2945
sudo apt update
3046
sudo apt install -y build-essential pkg-config libssl-dev clang libclang-dev cmake
3147
```
3248

33-
### 2) Build the node
49+
### 3) Build the node (source builds only)
3450

3551
```bash
3652
git clone https://github.com/catalyst-network/catalyst-node-rust
@@ -52,7 +68,7 @@ The binary is:
5268
./target/release/catalyst-cli --help
5369
```
5470

55-
### 3) Create a dedicated user + directories
71+
### 4) Create a dedicated user + directories
5672

5773
```bash
5874
sudo useradd --system --create-home --home-dir /var/lib/catalyst --shell /usr/sbin/nologin catalyst || true
@@ -61,7 +77,7 @@ sudo chown -R catalyst:catalyst /var/lib/catalyst
6177
sudo chmod 700 /var/lib/catalyst
6278
```
6379

64-
### 4) Generate a config (safe defaults)
80+
### 5) Generate a config (safe defaults)
6581

6682
Catalyst can generate a default config file if the path doesn’t exist.
6783

@@ -81,7 +97,7 @@ Stop it (Ctrl+C) after it starts once—this creates sibling directories near th
8197
Do **not** delete `node.key` during resets/upgrades unless you intend to change the node’s network identity.
8298
:::
8399

84-
### 5) Run under systemd
100+
### 6) Run under systemd
85101

86102
Create a unit file:
87103

@@ -122,6 +138,8 @@ sudo install -o catalyst -g catalyst -m 0755 \
122138
/var/lib/catalyst/node/catalyst-cli
123139
```
124140

141+
If you used a release binary and already installed it to `/var/lib/catalyst/node/catalyst-cli`, you can skip this step.
142+
125143
Start:
126144

127145
```bash
@@ -130,7 +148,7 @@ sudo systemctl enable --now catalyst
130148
sudo systemctl status catalyst --no-pager
131149
```
132150

133-
### 6) Firewall (minimum)
151+
### 7) Firewall (minimum)
134152

135153
If using `ufw`:
136154

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
sidebar_position: 0
3+
title: "Quickstart: I want to use Catalyst apps"
4+
---
5+
6+
This quickstart is for everyday users. The goal is to **use apps**—Catalyst should fade into the background.
7+
8+
## You will need
9+
10+
- A wallet app
11+
- (Testnet) Access to the faucet
12+
13+
## Steps
14+
15+
### 1) Start with a use case
16+
17+
Pick what you want to do:
18+
19+
- **[Send money](/docs/use-cases/send-money)**
20+
- **[Games and digital items](/docs/use-cases/games-assets)**
21+
- **[Social apps you control](/docs/use-cases/social-you-control)**
22+
23+
### 2) Create an account in your wallet
24+
25+
- Create a new account.
26+
- Back it up using the wallet’s instructions (offline is best).
27+
28+
If you’re new, see:
29+
30+
- **[Wallet → user guide](/docs/wallets/wallet-user-guide)**
31+
32+
### 3) Get testnet funds (testnet only)
33+
34+
- **[Faucet → user guide](/docs/faucet/user-guide)**
35+
36+
### 4) Verify activity (optional but recommended)
37+
38+
If something looks “stuck” in an app UI, the explorer can show the source of truth.
39+
40+
- **[Explorer → user guide](/docs/explorer/user-guide)**
41+
42+
## Verify
43+
44+
- You can see your balance in the wallet.
45+
- The explorer shows your account activity.
46+

site/docs/quickstarts/i-want-to-use-the-wallet.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ sidebar_position: 2
33
title: "Quickstart: I want to use the wallet"
44
---
55

6+
This quickstart is for everyday users. You don’t need to know how Catalyst works to use it.
7+
68
## You will need
79

810
- A supported wallet app (web wallet for testnet)
@@ -12,14 +14,20 @@ title: "Quickstart: I want to use the wallet"
1214

1315
1) Open the wallet and create/import an account.
1416

15-
2) Confirm the wallet shows the expected network identity before signing anything:
17+
2) Confirm you’re on the **right network** (testnet vs mainnet) before signing anything.
18+
19+
If you’re on testnet, your wallet should say “testnet” and show the expected network name.
20+
21+
<details>
22+
<summary>Advanced: exact testnet network identifiers</summary>
1623

1724
- `network_id`: `catalyst-testnet`
1825
- `chain_id`: `0xbf8457c` (hex) / `200820092` (decimal)
1926

2027
Canonical defaults (for the current testnet wallet implementation):
2128

2229
- `WebWallet/README.md`
30+
</details>
2331

2432
3) Request testnet funds from the faucet (testnet only):
2533

@@ -31,6 +39,6 @@ Canonical defaults (for the current testnet wallet implementation):
3139

3240
## Troubleshooting
3341

34-
- If the wallet refuses to sign, it’s often because **chain identity mismatched** (wrong RPC URL / wrong network).
42+
- If the wallet refuses to sign, it’s often because you’re connected to the **wrong network**.
3543
- Never paste your private key into websites or support chats. See **[Wallets → User guide](/docs/wallets/wallet-user-guide)**.
3644

site/docs/rpc-reference/transaction-lifecycle.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ sidebar_position: 1
33
title: "RPC: transaction lifecycle"
44
---
55

6+
:::note Not for everyday users
7+
If you’re just using a wallet or an app, you don’t need this page.
8+
9+
This page is for people building wallets, SDKs, dApps, and tooling that submit transactions directly to Catalyst RPC.
10+
:::
11+
612
This page is the canonical “how a tx moves through Catalyst” reference:
713

814
1) fetch domain

site/docs/sdk/get-started.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ sidebar_position: 1
33
title: Get started
44
---
55

6+
This section is for builders (dApps, tooling, wallets). If you’re just using apps, start with:
7+
8+
- **[Use cases (for everyone)](/docs/use-cases/send-money)**
9+
- **[Quickstart: use Catalyst apps](/docs/quickstarts/i-want-to-use-apps)**
10+
611
## You will need
712

813
- Node.js >= 20
@@ -35,6 +40,11 @@ console.log({
3540

3641
Your domain fetch should succeed and `genesisHashLen` should be `32`.
3742

43+
## Next steps
44+
45+
- **[Deploy a contract](/docs/sdk/deploy-contract)**
46+
- **[Common pitfalls](/docs/sdk/common-pitfalls)**
47+
3848
## Troubleshooting
3949

4050
- **Intermittent signature failures behind a load balancer**: ensure you use `getTxDomain` (single-call domain) rather than fetching chain identity via multiple RPC calls.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Use cases (for everyone)",
3+
"position": 5,
4+
"link": {
5+
"type": "generated-index",
6+
"title": "What can I do with Catalyst?",
7+
"description": "Real-world use cases, explained without jargon. Start here if you just want to use apps."
8+
}
9+
}
10+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Games and digital items you actually own
3+
sidebar_position: 2
4+
---
5+
6+
This page is for everyday users.
7+
8+
## The problem
9+
10+
In many games today:
11+
12+
- your items are trapped inside one game or one company
13+
- you can lose access if an account is banned or a game shuts down
14+
- you can’t easily prove an item is “really yours”
15+
16+
## What Catalyst enables
17+
18+
Catalyst can support games where:
19+
20+
- items can be **owned by you**, not just by a game server
21+
- items can **move between apps** (when the apps choose to support it)
22+
- ownership can be **verified publicly** (like checking a serial number)
23+
24+
You don’t need to learn the underlying technology to benefit from it—your wallet and game UI can make it feel normal.
25+
26+
## What you do (as a player)
27+
28+
### 1) Get a wallet
29+
30+
- Create an account and back it up.
31+
- **[Wallet → user guide](/docs/wallets/wallet-user-guide)**
32+
33+
### 2) Play a Catalyst-enabled game
34+
35+
When a game supports Catalyst, it can show:
36+
37+
- your items (in-game)
38+
- your ownership (in-wallet)
39+
- transfers (send/trade)
40+
41+
### 3) Verify ownership (optional)
42+
43+
If you ever want to double-check, the explorer can show activity tied to your account.
44+
45+
- **[Explorer → user guide](/docs/explorer/user-guide)**
46+
47+
## What to look for in good apps
48+
49+
- Clear “backup” guidance for your wallet
50+
- Human-friendly names/contacts (so you don’t paste long strings all day)
51+
- A simple “activity / receipts” page
52+
53+
## Troubleshooting
54+
55+
### “I can’t see my item in the wallet”
56+
57+
Not all wallets show every kind of in-game item yet. The game might still work fine even if the wallet UI is still catching up.
58+
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: How it works (plain English)
3+
sidebar_position: 10
4+
---
5+
6+
You don’t need to read this to use Catalyst apps, but it can help you feel confident.
7+
8+
## The three things you’ll see
9+
10+
### 1) A wallet
11+
12+
A wallet is an app that:
13+
14+
- creates your account
15+
- lets you send/receive money
16+
- keeps your “keys” (the secret needed to approve actions)
17+
18+
**Important:** if you lose your wallet backup, you can lose access.
19+
20+
### 2) Apps
21+
22+
Apps are what you actually use:
23+
24+
- games
25+
- social apps
26+
- marketplaces
27+
- tools
28+
29+
Good apps will make Catalyst “disappear” and just feel like normal software.
30+
31+
### 3) An explorer
32+
33+
An explorer is like a public receipt viewer. You can use it to:
34+
35+
- verify a payment happened
36+
- verify an app action was recorded
37+
- troubleshoot when an app UI is slow to update
38+
39+
## What a “transaction” is
40+
41+
A transaction is just a signed request from your wallet, like:
42+
43+
- “send 5 tokens to Alex”
44+
- “deploy this app feature”
45+
- “call this contract”
46+
47+
Your wallet signs it so the network can verify it’s really you approving it.
48+
49+
## Testnet vs mainnet
50+
51+
Testnet is for testing:
52+
53+
- funds are free (via a faucet)
54+
- things can reset or change
55+
56+
Mainnet is real:
57+
58+
- funds are not free
59+
- you should be more careful with backups and security
60+
61+
## Where to go next
62+
63+
- **[Quickstarts](/docs/quickstarts/i-want-to-use-the-wallet)**
64+
- **[Faucet → user guide](/docs/faucet/user-guide)**
65+
- **[Explorer → user guide](/docs/explorer/user-guide)**
66+

0 commit comments

Comments
 (0)