Skip to content

Commit ef09aa0

Browse files
authored
Add staking info and capability how-to (#26)
* Add "Manage Permissions" link in the start-here guide to improve user navigation for managing capabilities in Torus * refactor: update "Start Here" to "Table of Contents" across documentation for improved organization and clarity * feat: enhance documentation with collapsible sections and a new "Staking" guide for improved user experience and information access * fix: reformat links in documentation for token holders, agent builders, and swarm leaders for better readability and access * refactor: remove deprecated "Delegate Emission Streams" guide and tidy up table of contents for better documentation structure
1 parent be8950b commit ef09aa0

23 files changed

+282
-917
lines changed

astro.config.mjs

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ export default defineConfig({
3434
{
3535
label: "Explanations",
3636
items: [
37-
{ label: "Start Here", slug: "explanations/start-here" },
37+
{ 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" },
@@ -72,10 +80,10 @@ export default defineConfig({
7280
{
7381
label: "How-to Guides",
7482
items: [
75-
{ label: "Start Here", slug: "how-to-guides/start-here" },
83+
{ 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,21 +92,20 @@ 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" },
9199
{ label: "Manage Capabilities", slug: "how-to-guides/builders/manage-capabilities" },
100+
{ label: "Manage Permissions", slug: "how-to-guides/builders/manage-permissions" },
92101
{ label: "Create a Signal", slug: "how-to-guides/builders/create-signal" },
93-
// { label: "Manage Permissions", slug: "how-to-guides/builders/manage-permissions" },
94-
// { label: "Delegate Emission Streams", slug: "how-to-guides/builders/delegate-emission-streams" },
95102
{ label: "Setup Agent Server", slug: "how-to-guides/builders/setup-agent-server" },
96103
{ label: "Setup Agent Client", slug: "how-to-guides/builders/setup-agent-client" },
97104
],
98105
},
99106
{
100107
label: "Goal Leaders",
101-
collapsed: false,
108+
collapsed: true,
102109
items: [
103110
{ label: "Become a Root Agent", slug: "how-to-guides/goal-leaders/become-a-root-agent" },
104111
{ label: "Create Emission Proposal", slug: "how-to-guides/goal-leaders/create-emission-proposal" },
@@ -109,10 +116,10 @@ export default defineConfig({
109116
{
110117
label: "Development",
111118
items: [
112-
{ label: "Start Here", slug: "development/start-here" },
119+
{ label: "Table of Contents", slug: "development/table-of-contents" },
113120
{
114121
label: "Web Apps",
115-
collapsed: false,
122+
collapsed: true,
116123
items: [
117124
{
118125
label: "Overview and Setup",
@@ -126,7 +133,7 @@ export default defineConfig({
126133
},
127134
{
128135
label: "CLI Reference",
129-
collapsed: false,
136+
collapsed: true,
130137
items: [
131138
{ label: "Setup CLI", slug: "development/cli/setup-cli" },
132139
{ label: "Key Management", slug: "development/cli/key-management" },
@@ -135,7 +142,7 @@ export default defineConfig({
135142
},
136143
{
137144
label: "Network Operations",
138-
collapsed: false,
145+
collapsed: true,
139146
items: [
140147
{ label: "Global Parameters", slug: "development/network/global-parameters" },
141148
{ label: "Running a Node", slug: "development/network/running-node" },

src/content/docs/development/start-here.mdx renamed to src/content/docs/development/table-of-contents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Start Here
2+
title: Table of Contents
33
description: Technical documentation and tools for developing with and on Torus.
44
---
55
import {
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/start-here.mdx renamed to src/content/docs/explanations/table-of-contents.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Start Here
2+
title: Table of Contents
33
description: Deep-dive explanations to help you understand how Torus works under the hood.
44
---
55
import {
@@ -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,15 +29,23 @@ 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:
3543

3644
- [Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/) — Registration economics, burn mechanisms, and discovery
37-
- [Agent Server](https://docs.torus.network/explanations/builders/agent-server/) — API architecture, authentication, and capability sharing
38-
- [Agent Client](https://docs.torus.network/explanations/builders/agent-client/) — Communication patterns and authentication flow
3945
- [Agent Editing](https://docs.torus.network/explanations/builders/agent-editing/) — Update mechanics and storage architecture
4046
- [Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/) — Capability coordination and economic incentives
47+
- [Agent Server](https://docs.torus.network/explanations/builders/agent-server/) — API architecture, authentication, and capability sharing
48+
- [Agent Client](https://docs.torus.network/explanations/builders/agent-client/) — Communication patterns and authentication flow
4149

4250
---
4351

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>

0 commit comments

Comments
 (0)