Skip to content

Commit cf97cc9

Browse files
authored
Finish refactoring folder structure (#19)
* refine how-to guides: enhance clarity on agent management, signal creation, and bridging processes for improved user experience * revise agent documentation: streamline sections on agent editing, registration, and root agents for enhanced user understanding and experience * add agent client/server guides: implement step-by-step tutorials for setting up agent client and server with clear instructions and examples * update how-to guides: replace generic terms with "Torus" for improved specificity and cohesion across documentation * refactor agent documentation: replace generic terms with specific "Torus" references for clarity and consistency across guides * enhance explanations section: add detailed topics for better understanding of agent systems and related concepts in Torus documentation * remove navigation links: clean up outdated prev/next links from agent registration, demand signaling, and root agents documentation * update agent documentation: restructure sections for builders and leaders, enhancing hierarchy and clarity in Torus guides * remove setup guides: delete outdated CLI and wallet setup documentation from the Torus getting started section * update control space link: fix URL to point to the correct documentation page in the start-here section of Torus guides * Refactor config slugs for improved clarity; add immutable agent name warnings to documentation * Migrate balance operations and key management documentation to development directory; update links accordingly * Update web app documentation by restructuring file locations and links; delete outdated files and improve clarity in navigation
1 parent 2040bdb commit cf97cc9

31 files changed

+151
-438
lines changed

astro.config.mjs

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export default defineConfig({
2626
label: "Getting Started",
2727
items: [
2828
{ label: "Introduction", slug: "index" },
29-
{ label: "Tokenomics", slug: "concepts/tokenomics" },
29+
{ label: "Tokenomics", slug: "getting-started/tokenomics" },
3030
{
3131
label: "Concepts & Terminology",
3232
slug: "getting-started/concepts",
@@ -40,14 +40,14 @@ export default defineConfig({
4040
{
4141
label: "v0.5",
4242
items: [
43-
{ label: "Control Space", slug: "v05/control-space" },
44-
{ label: "Permission System", slug: "v05/permissions" },
43+
{ label: "Control Space", slug: "explanations/v05/control-space" },
44+
{ label: "Permission System", slug: "explanations/v05/permissions" },
4545
{
4646
label: "Capability Permissions",
47-
slug: "v05/capability-permissions",
47+
slug: "explanations/v05/capability-permissions",
4848
},
49-
{ label: "Emission Permissions", slug: "v05/emission-permissions" },
50-
{ label: "Governance & DAO", slug: "concepts/governance-dao" },
49+
{ label: "Emission Permissions", slug: "explanations/v05/emission-permissions" },
50+
{ label: "Governance & DAO", slug: "explanations/v05/governance-dao" },
5151
],
5252
},
5353
{
@@ -104,33 +104,48 @@ export default defineConfig({
104104
},
105105
],
106106
},
107-
{
108-
label: "CLI & Tools",
109-
items: [
110-
{ label: "Key Management", slug: "cli/key-management" },
111-
{ label: "Balance Operations", slug: "cli/balance-operations" },
112-
],
113-
},
107+
// {
108+
// label: "Web Apps",
109+
// items: [
110+
// { label: "Torus Portal", slug: "web-apps/torus-portal" },
111+
// { label: "Torus Allocator", slug: "web-apps/torus-allocator" },
112+
// { label: "Torus Wallet", slug: "web-apps/torus-wallet" },
113+
// { label: "Torus DAO", slug: "web-apps/torus-dao" },
114+
// ],
115+
// },
114116
{
115117
label: "Development",
116118
items: [
119+
{ label: "Start Here", slug: "development/start-here" },
117120
{
118-
label: "Web Apps Overview and Setup",
119-
slug: "development/web-apps-overview-and-setup",
121+
label: "Web Apps",
122+
collapsed: false,
123+
items: [
124+
{
125+
label: "Overview and Setup",
126+
slug: "development/web/overview-and-setup",
127+
},
128+
{
129+
label: "Querying Data",
130+
slug: "development/web/querying-data",
131+
},
132+
],
120133
},
121134
{
122-
label: "Querying Data",
123-
slug: "development/querying-data",
135+
label: "CLI Reference",
136+
collapsed: false,
137+
items: [
138+
{ label: "Key Management", slug: "development/cli/key-management" },
139+
{ label: "Balance Operations", slug: "development/cli/balance-operations" },
140+
],
124141
},
125-
],
126-
},
127-
{
128-
label: "Network Operations",
129-
items: [
130-
{ label: "Global Parameters", slug: "network/global-parameters" },
131142
{
132-
label: "Running a Node",
133-
slug: "network/running-node",
143+
label: "Network Operations",
144+
collapsed: false,
145+
items: [
146+
{ label: "Global Parameters", slug: "development/network/global-parameters" },
147+
{ label: "Running a Node", slug: "development/network/running-node" },
148+
],
134149
},
135150
],
136151
},

src/content/docs/concepts/agents.mdx

Lines changed: 0 additions & 26 deletions
This file was deleted.

src/content/docs/concepts/network-overview.mdx

Lines changed: 0 additions & 64 deletions
This file was deleted.

src/content/docs/cli/balance-operations.mdx renamed to src/content/docs/development/cli/balance-operations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ The unstaking command is defined as follows:
4343
torus balance unstake <key-name> <amount> <allocator-ss58address>
4444
```
4545

46-
You can also specify the name of the key, if it's located on your disk. Same as in transferring or staking.
46+
You can also specify the name of the key, if it's located on your disk. Same as in transferring or staking.

src/content/docs/cli/key-management.mdx renamed to src/content/docs/development/cli/key-management.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This command displays both public and private key details, ensuring you have acc
4545
To list all keys stored on your system, execute:
4646

4747
```sh
48-
# Lists the names and addresses of keys stored on disk.
48+
# Lists the names and addresses of keys stored on disk.
4949
torus key list
5050
```
5151

@@ -69,4 +69,4 @@ You can also sort the balance by **all, free, staked** (default all summed balan
6969
torus key balances --sort-balance free
7070
```
7171

72-
Will return the keys sorted by their free balance.
72+
Will return the keys sorted by their free balance.

src/content/docs/network/global-parameters.mdx renamed to src/content/docs/development/network/global-parameters.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ You can query all of these global parameters using CLI:
8686

8787
```bash
8888
torus network params
89-
```
89+
```

src/content/docs/network/running-node.mdx renamed to src/content/docs/development/network/running-node.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,4 @@ cargo xtask run local --alice
8585

8686
## Additional Information
8787

88-
- You can customize your node's configuration by modifying the appropriate files in the project.
88+
- You can customize your node's configuration by modifying the appropriate files in the project.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Start Here
3+
description: Technical documentation and tools for developing with and on Torus.
4+
---
5+
import {
6+
Steps,
7+
Aside,
8+
CardGrid,
9+
Card,
10+
Tabs,
11+
TabItem
12+
} from "@astrojs/starlight/components";
13+
14+
Welcome to the **Development** section of the Torus documentation.
15+
16+
This section provides comprehensive technical resources for developers building with Torus — from setting up development environments to running nodes and managing keys.
17+
Whether you're integrating with existing web apps, querying data, or running your own infrastructure, you'll find the technical details here.
18+
19+
## Web Application Development
20+
21+
Building and integrating with the Torus ecosystem:
22+
23+
- [Overview and Setup](https://docs.torus.network/development/web/overview-and-setup/) — Setting up the development environment and understanding the monorepo structure
24+
- [Querying Data](https://docs.torus.network/development/web/querying-data/) — API operations for retrieving stake allocation and network data
25+
26+
---
27+
28+
## CLI & Tools
29+
30+
Command-line operations for key and balance management:
31+
32+
- [Key Management](https://docs.torus.network/development/cli/key-management/) — Creating, importing, and managing cryptographic keys
33+
- [Balance Operations](https://docs.torus.network/development/cli/balance-operations/) — Transferring and staking operations via CLI
34+
35+
---
36+
37+
## Network Infrastructure
38+
39+
Running and configuring Torus network infrastructure:
40+
41+
- [Global Parameters](https://docs.torus.network/development/network/global-parameters/) — Understanding and configuring blockchain parameters
42+
- [Running a Node](https://docs.torus.network/development/network/running-node/) — Setting up and operating a Torus Substrate node
43+
44+
---
45+
46+
## Questions Not Covered Here?
47+
48+
Need help with development tasks? The community is here to help:
49+
50+
- **[Discord](https://discord.gg/torus)** — Technical discussions, support, and announcements
51+
- **[Telegram](https://t.me/torusnetwork)** — General chat and announcements
52+
- **[Twitter](https://x.com/torus_network)** — Updates and ecosystem news
53+
54+
### Core Projects
55+
56+
Explore the open source code to understand implementation details:
57+
58+
- **[torus-substrate](https://github.com/renlabs-dev/torus-substrate)** — Core blockchain runtime built on Substrate
59+
- **[torus-ts](https://github.com/renlabs-dev/torus-ts)** — TypeScript SDK for building on Torus and WebApps
60+
- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation

0 commit comments

Comments
 (0)