Skip to content

Commit a76fbe2

Browse files
committed
feat: enhance documentation with collapsible sections and a new "Staking" guide for improved user experience and information access
1 parent 39ea640 commit a76fbe2

16 files changed

+221
-179
lines changed

astro.config.mjs

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export default defineConfig({
3737
{ label: "Table of Contents", slug: "explanations/table-of-contents" },
3838
{
3939
label: "v0.5",
40+
collapsed: true,
4041
items: [
4142
{ label: "Control Space", slug: "explanations/v05/control-space" },
4243
{ label: "Permission System", slug: "explanations/v05/permissions" },
@@ -48,9 +49,16 @@ export default defineConfig({
4849
{ label: "Governance & DAO", slug: "explanations/v05/governance-dao" },
4950
],
5051
},
52+
{
53+
label: "Holders",
54+
collapsed: true,
55+
items: [
56+
{ label: "Staking", slug: "explanations/holders/staking" },
57+
],
58+
},
5159
{
5260
label: "Builders",
53-
collapsed: false,
61+
collapsed: true,
5462
items: [
5563
{ label: "Agent Registration", slug: "explanations/builders/agent-registration" },
5664
{ label: "Agent Editing", slug: "explanations/builders/agent-editing" },
@@ -61,7 +69,7 @@ export default defineConfig({
6169
},
6270
{
6371
label: "Goal Leaders",
64-
collapsed: false,
72+
collapsed: true,
6573
items: [
6674
{ label: "Root Agents", slug: "explanations/goal-leaders/root-agents" },
6775
{ label: "Emission Proposals", slug: "explanations/goal-leaders/emission-proposals" },
@@ -75,7 +83,7 @@ export default defineConfig({
7583
{ label: "Table of Contents", slug: "how-to-guides/table-of-contents" },
7684
{
7785
label: "Holders",
78-
collapsed: false,
86+
collapsed: true,
7987
items: [
8088
{ label: "Setup a Wallet", slug: "how-to-guides/holders/setup-a-wallet" },
8189
{ label: "Bridge from Base", slug: "how-to-guides/holders/bridge-from-base" },
@@ -84,7 +92,7 @@ export default defineConfig({
8492
},
8593
{
8694
label: "Builders",
87-
collapsed: false,
95+
collapsed: true,
8896
items: [
8997
{ label: "Register an Agent", slug: "how-to-guides/builders/register-an-agent" },
9098
{ label: "Edit your Agent", slug: "how-to-guides/builders/edit-your-agent" },
@@ -98,7 +106,7 @@ export default defineConfig({
98106
},
99107
{
100108
label: "Goal Leaders",
101-
collapsed: false,
109+
collapsed: true,
102110
items: [
103111
{ label: "Become a Root Agent", slug: "how-to-guides/goal-leaders/become-a-root-agent" },
104112
{ label: "Create Emission Proposal", slug: "how-to-guides/goal-leaders/create-emission-proposal" },
@@ -112,7 +120,7 @@ export default defineConfig({
112120
{ label: "Table of Contents", slug: "development/table-of-contents" },
113121
{
114122
label: "Web Apps",
115-
collapsed: false,
123+
collapsed: true,
116124
items: [
117125
{
118126
label: "Overview and Setup",
@@ -126,7 +134,7 @@ export default defineConfig({
126134
},
127135
{
128136
label: "CLI Reference",
129-
collapsed: false,
137+
collapsed: true,
130138
items: [
131139
{ label: "Setup CLI", slug: "development/cli/setup-cli" },
132140
{ label: "Key Management", slug: "development/cli/key-management" },
@@ -135,7 +143,7 @@ export default defineConfig({
135143
},
136144
{
137145
label: "Network Operations",
138-
collapsed: false,
146+
collapsed: true,
139147
items: [
140148
{ label: "Global Parameters", slug: "development/network/global-parameters" },
141149
{ label: "Running a Node", slug: "development/network/running-node" },
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Staking
3+
description: Understanding the staking mechanism, incentives, and how token holders participate in Torus network security and governance.
4+
---
5+
6+
import {
7+
Aside,
8+
Card,
9+
CardGrid,
10+
Code,
11+
Steps,
12+
Tabs,
13+
TabItem,
14+
} from "@astrojs/starlight/components";
15+
16+
17+
Stake is the organism's root container of authority and monetary energy, transmutable towards its emergent agency.
18+
Forming a circular value flow between incentives and stake in their outcome. Stake is permissionless, while everything else is permissioned by stake.
19+
20+
Staking is the core mechanism through which TORUS holders secure the network, participate in governance,
21+
and earn rewards while supporting the agents and initiatives they believe in.
22+
23+
24+
### Core Mechanics
25+
26+
- When you stake, your TORUS are **locked** in the Root Allocator
27+
- Tokens remain **owned by the staker** but cannot be used for transaction purposes
28+
- It accounts for network consensus, such as, voting, allocating and commenting on proposals
29+
- Staking rewards are generated from network emissions
30+
31+
## Related Concepts
32+
33+
- **[Tokenomics](https://docs.torus.network/getting-started/tokenomics/)** - Understanding TORUS token economics and emission structure
34+
- **[Emission Proposals](https://docs.torus.network/explanations/goal-leaders/emission-proposals/)** - How staking parameters can be adjusted through governance
35+
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Understanding the agents you can support through staking
36+
37+
<Aside type="tip" title="Ready to Start Staking?">
38+
Follow our [staking guide](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) to learn the step-by-step process for staking your TORUS tokens.
39+
</Aside>

src/content/docs/explanations/table-of-contents.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Welcome to the **Explanations** section of the Torus documentation.
1515

1616
If you need to accomplish a specific task, check out our [How-to Guides](https://docs.torus.network/how-to-guides/start-here/) instead.
1717

18-
These explanations provide deep understanding of how Torus works the concepts, mechanisms of Torus.
18+
These explanations provide deep understanding of how Torus works, the concepts, mechanisms of Torus.
1919

2020
## v0.5 Related Topics
2121

@@ -29,6 +29,14 @@ Understanding the technical implementation and design of Torus v0.5:
2929

3030
---
3131

32+
## For Holders
33+
34+
Understanding how holders participate in the network:
35+
36+
- [Staking](https://docs.torus.network/explanations/holders/staking/) — Staking mechanisms, incentives, and reward distribution
37+
38+
---
39+
3240
## For Builders (Agents)
3341

3442
Understanding how agent systems work within Torus:

src/content/docs/how-to-guides/builders/create-permission.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,10 @@ After creating permissions, you can:
262262
For help with permission management:
263263

264264
- [Torus Community Discord](https://discord.gg/torus)
265-
- [Permission System Documentation](https://docs.torus.network/explanations/v05/permissions/)
265+
266+
<Aside type="tip" title="Want to Learn More?">
267+
See the [Permission System Documentation](https://docs.torus.network/explanations/v05/permissions/) for technical details.
268+
</Aside>
266269

267270
#### Related Topics
268271

src/content/docs/how-to-guides/builders/create-signal.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,8 @@ Now that you've created a signal, you might want to:
109109
Connect with the community:
110110
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
111111
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
112-
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
112+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
113+
114+
<Aside type="tip" title="Want to Learn More?">
115+
Learn about [demand signaling](https://docs.torus.network/explanations/builders/demand-signaling/) capability coordination and economic incentives.
116+
</Aside>

src/content/docs/how-to-guides/builders/delegate-emission-streams.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,10 @@ With emission delegations configured, you can:
343343
For help with emission delegations:
344344

345345
- [Torus Community Discord](https://discord.gg/torus)
346-
- [Emission Permissions Documentation](https://docs.torus.network/explanations/v05/emission-permissions/)
346+
347+
<Aside type="tip" title="Want to Learn More?">
348+
See the [Emission Permissions Documentation](https://docs.torus.network/explanations/v05/emission-permissions/) for technical details.
349+
</Aside>
347350

348351
#### Related Topics
349352

src/content/docs/how-to-guides/builders/edit-your-agent.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,8 @@ After updating your agent information:
103103
Connect with the community:
104104
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
105105
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
106-
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
106+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
107+
108+
<Aside type="tip" title="Want to Learn More?">
109+
Learn about [agent editing](https://docs.torus.network/explanations/builders/agent-editing/) update mechanics and storage architecture.
110+
</Aside>

src/content/docs/how-to-guides/builders/manage-capabilities.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,11 +156,15 @@ By removing outdated or unused capabilities, you reduce the attack surface and k
156156

157157
Now that you can manage capabilities, you might want to:
158158

159-
- **Set up delegation**: Delegate permissions to allow other agents to use your capabilities *(coming soon)*
159+
- **Set up delegation**: [Manage permissions](https://docs.torus.network/how-to-guides/builders/manage-permissions/) to allow other agents to use your capabilities
160160
- **Build agent services**: Create an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide APIs that utilize your registered capabilities
161161
- **Create demand signals**: Signal for [specific capabilities](https://docs.torus.network/how-to-guides/builders/create-signal/) you need from other agents
162162

163163
Connect with the community:
164164
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
165165
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
166-
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
166+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
167+
168+
<Aside type="tip" title="Want to Learn More?">
169+
Learn about [capability permissions](https://docs.torus.network/explanations/v05/capability-permissions/) delegation mechanisms and control space architecture.
170+
</Aside>

0 commit comments

Comments
 (0)