Skip to content

Commit eaa218b

Browse files
committed
Add data dir
1 parent 59e2521 commit eaa218b

File tree

4 files changed

+37
-4
lines changed

4 files changed

+37
-4
lines changed

docs/sage/directory.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
# Data Directory
5+
6+
All files used by Sage are stored in a single location, inside of the system's default [data dir](https://docs.rs/dirs/latest/dirs/fn.data_dir.html).
7+
8+
<Tabs groupId="operating-systems">
9+
<TabItem value="win" label="Windows">`C:\Users\Alice\AppData\Roaming\com.rigidnetwork.sage`</TabItem>
10+
<TabItem value="mac" label="MacOS">`/Users/Alice/Library/Application Support/com.rigidnetwork.sage`</TabItem>
11+
<TabItem value="linux" label="Linux">`/home/alice/.local/share/com.rigidnetwork.sage`</TabItem>
12+
</Tabs>
13+
14+
:::note
15+
The username `Alice` is a placeholder, and must be replaced by your actual username.
16+
:::
17+
18+
## Files
19+
20+
| Name | Description |
21+
| --------------- | ---------------------------------------------------------------- |
22+
| `config.toml` | The main configuration file used by the app. |
23+
| `keys.bin` | A binary encoding of all imported keys. |
24+
| `logs` | Logs emitted by the backend of the app. |
25+
| `networks.toml` | Information about blockchain networks (ie mainnet or testnet11). |
26+
| `peers` | Binary files that store previous peer connections. |
27+
| `ssl` | The SSL certificate used for full node connections and the RPC. |
28+
| `wallets` | SQLite databases for each network and key pair. |
29+
| `wallets.toml` | Configuration for each imported wallet. |

docs/sage/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
---
2-
slug: /sage
2+
slug: /
33
---
44

5-
# Sage
5+
# Sage Wallet
6+
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+
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).

sidebars.ts

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

33
const sidebars: SidebarsConfig = {
4-
sageSidebar: ["sage/index"],
4+
sageSidebar: ["sage/index", "sage/directory"],
55
sdkSidebar: ["sdk/index"],
66
};
77

src/pages/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function HomepageHeader() {
1919
<p className="hero__subtitle">{siteConfig.tagline}</p>
2020
<div className={styles.buttons}>
2121
<Link className="button button--secondary button--lg" to="/docs/sage">
22-
Documentation
22+
Get Started
2323
</Link>
2424
</div>
2525
</div>

0 commit comments

Comments
 (0)