Skip to content

Commit 64b5552

Browse files
committed
Add getting started instructions
1 parent 8323425 commit 64b5552

File tree

5 files changed

+93
-14
lines changed

5 files changed

+93
-14
lines changed

docs/sage/index.md

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,71 @@
22
slug: /
33
---
44

5-
# Sage Wallet
5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
67

7-
Sage is a fully featured Chia wallet built on top of the Wallet SDK. In addition to a desktop and mobile app, it provides a WalletConnect API for dApp integration, and an RPC interface for scripting. The RPC API allows you to do everything you can do with the GUI, and it can be used via HTTP or the CLI interface.
8+
# Getting Started
89

9-
If you're looking for a simple API to automate actions on the wallet's behalf, you should start by using the Sage RPC. However, if you are contributing to Sage or want to build your own standalone wallet app, you may need the flexibility provided by the Wallet SDK (which comes at the cost of complexity).
10+
The goal of this website is to provide documentation for Sage and the Wallet SDK it's built with. It will cover a wide range of topics, from configuring and using Sage and its RPCs to building your own applications that utilize the Wallet SDK library to connect to the Chia blockchain.
11+
12+
:::note
13+
If you are looking for download instructions for the app, visit the [Sage Website](https://sagewallet.net).
14+
:::
15+
16+
## Source Installation
17+
18+
Sage is built with [Tauri v2](https://tauri.app/), a framework for building efficient cross-platform applications that work on both desktop and mobile devices. You will need to follow the [Prerequisites](https://tauri.app/start/prerequisites/) section of the Tauri docs before proceeding with a source installation.
19+
20+
You will also need to have both [Rustup](https://rustup.rs/) and [PNPM](https://pnpm.io/installation) installed.
21+
22+
Clone the repo and run the following command to install the frontend dependencies:
23+
24+
```bash
25+
pnpm install
26+
```
27+
28+
This is how you can compile and start the app in debug mode, for development or testing purposes:
29+
30+
<Tabs groupId="tauri-builds">
31+
<TabItem value="desktop" label="Desktop">
32+
```bash
33+
pnpm tauri dev
34+
```
35+
</TabItem>
36+
<TabItem value="ios" label="iOS">
37+
```bash
38+
pnpm tauri ios dev
39+
```
40+
</TabItem>
41+
<TabItem value="android" label="Android">
42+
```bash
43+
pnpm tauri android dev
44+
```
45+
</TabItem>
46+
</Tabs>
47+
48+
:::note
49+
This will create an unoptimized build of the app, which can result in some performance issues. If needed, you can use the `--release` flag to run a release optimized version instead.
50+
:::
51+
52+
### Production Build
53+
54+
If you need to compile the app into a production binary, you can do that as well:
55+
56+
<Tabs groupId="tauri-builds">
57+
<TabItem value="desktop" label="Desktop">
58+
```bash
59+
pnpm tauri build
60+
```
61+
</TabItem>
62+
<TabItem value="ios" label="iOS">
63+
```bash
64+
pnpm tauri ios build
65+
```
66+
</TabItem>
67+
<TabItem value="android" label="Android">
68+
```bash
69+
pnpm tauri android build
70+
```
71+
</TabItem>
72+
</Tabs>

docs/sage/rpc/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# RPC API
2+
3+
:::note
4+
You will need to start the RPC server in Settings => Advanced => RPC Server. Optionally, it can also be set to start automatically when the GUI is opened.
5+
:::
6+
7+
![Sage RPC settings](/img/screenshots/rpc.png)

docusaurus.config.ts

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ const config: Config = {
6363
title: "Learn",
6464
items: [
6565
{
66-
label: "Sage",
67-
href: "/docs",
66+
label: "Chia Docs",
67+
href: "https://docs.chia.net",
6868
},
6969
{
70-
label: "Wallet SDK",
71-
href: "/docs/sdk",
70+
label: "Chialisp Docs",
71+
href: "https://chialisp.com",
7272
},
7373
],
7474
},
@@ -89,15 +89,11 @@ const config: Config = {
8989
title: "Contribute",
9090
items: [
9191
{
92-
label: "Website GitHub",
93-
href: "https://github.com/xch-dev/docs",
94-
},
95-
{
96-
label: "Wallet SDK GitHub",
92+
label: "Wallet SDK",
9793
href: "https://github.com/xch-dev/chia-wallet-sdk",
9894
},
9995
{
100-
label: "Sage GitHub",
96+
label: "Sage",
10197
href: "https://github.com/xch-dev/sage",
10298
},
10399
],

sidebars.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
22

33
const sidebars: SidebarsConfig = {
4-
sageSidebar: ["sage/index", "sage/directory"],
4+
sageSidebar: [
5+
{ type: "doc", id: "sage/index" },
6+
{ type: "doc", id: "sage/directory" },
7+
{
8+
type: "category",
9+
label: "RPC API",
10+
link: {
11+
type: "generated-index",
12+
description:
13+
"Explore the API provided by the Sage RPC, as well as instructions on how to set it up.",
14+
},
15+
items: ["sage/rpc/index"],
16+
},
17+
],
518
sdkSidebar: ["sdk/index"],
619
};
720

static/img/screenshots/rpc.png

526 KB
Loading

0 commit comments

Comments
 (0)