Skip to content

Commit a5613a8

Browse files
committed
add torus allocator part
1 parent 1d573c6 commit a5613a8

5 files changed

Lines changed: 72 additions & 58 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@ pnpm-debug.log*
2121

2222
# macOS-specific files
2323
.DS_Store
24+
25+
.env.local

astro.config.mjs

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export default defineConfig({
3737
{
3838
label: "v0.5",
3939
items: [
40-
// { label: "Network Overview", slug: "concepts/network-overview" },
40+
{ label: "Network Overview", slug: "concepts/network-overview" },
4141
{ label: "Control Space", slug: "v05/control-space" },
4242
{ label: "Permission System", slug: "v05/permissions" },
4343
{ label: "Capability Permissions", slug: "v05/capability-permissions" },
@@ -51,7 +51,7 @@ export default defineConfig({
5151
items: [
5252
{ label: "Register an Agent", slug: "agents/register-agent" },
5353
{ label: "Become a Root Agent", slug: "agents/apply-root-agent" },
54-
{ label: "Agent Server Setup", slug: "agents/server-setup" },
54+
{ label: "Agent Server", slug: "agents/server-setup" },
5555
{ label: "Agent Client", slug: "agents/client" },
5656
{ label: "Demand Signaling", slug: "agents/demand-signaling" },
5757
{ label: "Managing Your Agent", slug: "agents/management" },
@@ -64,20 +64,16 @@ export default defineConfig({
6464
{ label: "Balance Operations", slug: "cli/balance-operations" },
6565
],
6666
},
67-
// {
68-
// label: "Web Apps",
69-
// items: [
70-
// {
71-
// label: "Overview",
72-
// slug: "development/web-apps-overview",
73-
// },
74-
// { label: "Torus Portal", slug: "web-apps/torus-portal" },
75-
// { label: "Torus Allocator", slug: "web-apps/torus-allocator" },
76-
// { label: "Torus Wallet", slug: "web-apps/torus-wallet" },
77-
// { label: "Torus Bridge", slug: "web-apps/torus-bridge" },
78-
// { label: "Torus DAO", slug: "web-apps/torus-dao" },
79-
// ],
80-
// },
67+
{
68+
label: "Web Apps",
69+
items: [
70+
{ label: "Torus Portal", slug: "web-apps/torus-portal" },
71+
{ label: "Torus Allocator", slug: "web-apps/torus-allocator" },
72+
{ label: "Torus Wallet", slug: "web-apps/torus-wallet" },
73+
{ label: "Torus Bridge", slug: "web-apps/torus-bridge" },
74+
{ label: "Torus DAO", slug: "web-apps/torus-dao" },
75+
],
76+
},
8177
{
8278
label: "Development",
8379
items: [
@@ -102,18 +98,8 @@ export default defineConfig({
10298
],
10399
},
104100
],
105-
editLink: {
106-
baseUrl: "https://github.com/renlabs-dev/torus-docs/edit/main/docs/",
107-
},
108101
customCss: ["./src/tailwind.css"],
109102
}),
110103
tailwind({ applyBaseStyles: false }),
111104
],
112-
113-
vite: {
114-
server: {
115-
host: true,
116-
allowedHosts: true,
117-
},
118-
},
119105
});

src/content/docs/agents/register-agent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ prev:
55
link: /concepts/governance-dao
66
label: Governance & DAO
77
next:
8-
link: /agents/apply-root-agent
9-
label: Become a Root Agent
8+
link: /agents/client
9+
label: Interacting with Agents
1010
---
1111

1212
import {
Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,72 @@
11
---
22
title: How to Use Torus Allocator
3-
description: Complete guide to discovering agents, allocating stake, and managing delegations.
3+
description: Guide to discovering root agents and allocating your stake weight.
44
---
55

6-
import { Aside, Card, CardGrid, Code, Tabs, TabItem, LinkCard } from "@astrojs/starlight/components";
6+
import { Aside, CardGrid, LinkCard } from "@astrojs/starlight/components";
77

8-
Learn how to use Torus Allocator to discover agents, allocate your stake, and manage your delegation strategy for optimal returns.
8+
Torus Allocator lets you allocate your stake weight to root agents. Weight allocation determines how emissions are distributed - agents with more weight receive more emissions.
99

10-
## Overview
10+
## Prerequisites
1111

12-
Torus Allocator is the primary interface for discovering and evaluating agents, allowing you to make informed decisions about stake allocation and support the agents you believe in.
12+
**Stake Requirement**: You must have TORUS staked on the "Torus Allocator" allocator before you can allocate weights.
1313

14-
**Key Features:**
15-
- Browse and discover agents
16-
- Allocate stake to promising agents
17-
- Manage delegation strategy
14+
For staking details, see [torus wallet](torus-wallet).
1815

19-
## Getting Started
16+
## Interface Overview
2017

21-
[Content to be added - accessing Torus Allocator and initial setup]
18+
**Main View**: Browse all root agents showing:
19+
- Agent name and social links
20+
- TORUS emissions received from stake root
21+
- Short description
2222

23-
## Discovering Agents
23+
**Weight Allocation**: Use sliders to distribute your weight (0-100%) across multiple root agents.
2424

25-
[Content to be added - how to browse, search, and filter agents]
25+
**Allocation Menu**: Review and submit your weight distribution.
2626

27-
## Stake Allocation
27+
## Agent Details
2828

29-
[Content to be added - how to allocate and manage stake across agents]
29+
**Expanded View**: Click any root agent to see detailed information:
30+
- Agent address and API endpoint
31+
- USD value of emissions received
32+
- Full agent description
33+
- "Report Agent to DAO" option
34+
35+
**Agent Management**: If you're a root agent owner, you can edit your agent information directly in the expanded view.
36+
37+
## Allocating Weights
38+
39+
1. **Connect**: Visit [allocator.torus.network](https://allocator.torus.network) and connect wallet
40+
2. **Browse Agents**: Review available root agents and their metrics
41+
3. **Set Weights**: Use sliders to allocate percentages to chosen agents
42+
4. **Open Allocation Menu**: Review your weight distribution
43+
5. **Submit**: Confirm allocations and sign transaction
44+
45+
<Aside type="note">
46+
Total weight allocation must equal 100% or 0%. You can diversify across multiple agents, but the total must always be 100%.
47+
</Aside>
3048

3149
## Managing Allocations
3250

33-
[Content to be added - how to rebalance and optimize your stake allocations]
51+
**Removing Allocations**:
52+
1. Open "Allocation Menu"
53+
2. Click "Remove Agents"
54+
3. Sign the transaction
55+
56+
**Updating Allocations**:
57+
- Adjust sliders for new distribution
58+
- Submit changes through Allocation Menu
59+
- Previous allocations are automatically replaced
3460

3561
<CardGrid>
3662
<LinkCard
37-
title="Stake & Weights"
38-
href="/concepts/stake-weights"
39-
description="Understand how staking and weights work in the network."
63+
title="Torus Portal"
64+
href="/web-apps/torus-portal"
65+
description="Manage permissions and capabilities"
4066
/>
4167
<LinkCard
42-
title="Agents"
43-
href="/concepts/agents"
44-
description="Learn about agents and how they create value."
68+
title="Torus Wallet"
69+
href="/web-apps/torus-wallet"
70+
description="Manage your stake and allocations"
4571
/>
4672
</CardGrid>

src/content/docs/web-apps/torus-portal.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Torus Portal is the web interface for managing permissions and capabilities. Use
2525
2. **Fill Form**: Configure delegator, recipient, scope, duration
2626
3. **Submit**: Create the permission
2727

28-
For permission details, see [Permissions System](../v05/permissions.mdx).
28+
For permission details, see [Permissions System](../v05/permissions).
2929

3030
## Managing Capabilities
3131

@@ -41,11 +41,11 @@ For permission details, see [Permissions System](../v05/permissions.mdx).
4141
2. **Choose Granularity**: Delete specific method or entire capability
4242
3. **Confirm**: Delete (only works if no active delegations exist)
4343

44-
For Capability concepts, see [Capability Permissions](../v05/capability-permissions.mdx).
44+
For Capability concepts, see [Capability Permissions](../v05/capability-permissions).
4545

4646
## Network Operations
4747

48-
**Register Agent**: Basic agent registration (different from [root agent registration](../agents/apply-root-agent.mdx))
48+
**Register Agent**: Basic agent registration (different from [root agent registration](../agents/apply-root-agent))
4949

5050
**Create Signal**: Broadcast coordination messages to other agents in the network
5151

@@ -64,17 +64,17 @@ Always check dependency warnings before deleting capabilities - you cannot delet
6464
<CardGrid>
6565
<LinkCard
6666
title="Emission Permissions"
67-
href="/advanced/emission-permissions"
67+
href="/v05/emission-permissions"
6868
description="Learn about token delegation mechanics"
6969
/>
7070
<LinkCard
7171
title="Capability Permissions"
72-
href="/advanced/namespace-permissions"
72+
href="/v05/capability-permissions"
7373
description="Understand service access control"
7474
/>
7575
<LinkCard
76-
title="Namespaces"
77-
href="/advanced/namespaces"
78-
description="Namespace structure and concepts"
76+
title="Control Space"
77+
href="/v05/control-space"
78+
description="Control space and concepts"
7979
/>
8080
</CardGrid>

0 commit comments

Comments
 (0)