Skip to content

Commit 7453d37

Browse files
authored
Merge pull request #9 from renlabs-dev/dev
update root agent doc
2 parents 7ce4a64 + 1a0d78b commit 7453d37

18 files changed

Lines changed: 556 additions & 205 deletions

astro.config.mjs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ export default defineConfig({
2626
label: "Getting Started",
2727
items: [
2828
{ label: "Introduction", slug: "index" },
29-
{ label: "Concepts & Terminology", slug: "getting-started/concepts" },
29+
{
30+
label: "Concepts & Terminology",
31+
slug: "getting-started/concepts",
32+
},
3033
{ label: "Setup CLI", slug: "getting-started/setup-cli" },
3134
{ label: "Setup Wallet", slug: "getting-started/setup-wallet" },
3235
],
@@ -79,8 +82,8 @@ export default defineConfig({
7982
label: "Development",
8083
items: [
8184
{
82-
label: "Development Guide",
83-
slug: "development/guide",
85+
label: "Web Apps Overview and Setup",
86+
slug: "development/web-apps-overview-and-setup",
8487
},
8588
{
8689
label: "Querying Data",
@@ -106,7 +109,7 @@ export default defineConfig({
106109
}),
107110
tailwind({ applyBaseStyles: false }),
108111
],
109-
112+
110113
vite: {
111114
server: {
112115
host: true,

src/content/docs/agents/apply-root-agent.mdx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,11 @@ import {
1919
TabItem,
2020
} from "@astrojs/starlight/components";
2121

22-
Root agents have enhanced capabilities in Torus, including the ability to receive emissions directly from the root network and earn from stake allocations. However, becoming a root agent requires approval from DAO members through a whitelist process.
22+
Root agents can be used to set goals under which swarms of agents can form.
2323

24-
## What is a Root Agent?
24+
All agents have the option to become root agents, which enables them to receive emissions directly from the stake root ([torus-allocator](https://allocator.torus.network/)). Otherwise, they act like normal agents.
2525

26-
**Root Agent Features:**
27-
28-
- Can receive emissions directly from the root network
29-
- Can receive stake and earn emissions from allocators
30-
- Requires DAO approval through whitelist process
26+
Becoming a root agent only makes sense for agents that do not fit within the scope of any existing root agents, but have a clear value proposition to Torus. However, becoming a root agent requires approval from DAO members through an application process.
3127

3228
## Prerequisites
3329

@@ -69,7 +65,7 @@ Root agent status is achieved through a DAO voting process.
6965

7066
<Steps>
7167

72-
1. Visit the [Whitelist Applications](https://dao.torus.network/whitelist-applications) tab in the [Torus DAO](https://dao.torus.network/k)
68+
1. Visit the [Whitelist Applications](https://dao.torus.network/whitelist-applications) tab in the [Torus DAO](https://dao.torus.network/)
7369
2. Connect your Torus wallet
7470
3. Click "Shape the Network" to open the application form
7571
4. Select "Whitelist an Agent" for root agent application

src/content/docs/agents/demand-signaling.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ prev:
55
link: /agents/client
66
label: Setup your Client
77
next:
8-
link: /agents/emission-stream-allocation
9-
label: Emission Stream Allocation
8+
link: /agents/management
9+
label: Managing your Agent
1010
---
1111

1212
import {
@@ -19,27 +19,27 @@ import {
1919
TabItem,
2020
} from "@astrojs/starlight/components";
2121

22-
### Capability demand signaling system
22+
### Capability demand signaling system
2323

24-
The ["create signal"](https://portal.torus.network/create-signal) feature on the Portal allows agents to technically and economically express their demand for specialized capabilities from other agents.
24+
The **"create signal"** feature on the Portal allows root agents to express in a technical and economical way their demand for specialized capabilities from other agents.
2525

26-
Agents are looking for opportunities to receive emission delegations by providing specialized capabilities. This means, you can define a problem and advertise it to agents by proposing an allocation of your own emissions for it.
26+
Standard agents are looking for opportunities to receive emission delegations by providing specialized capabilities. This means, you can define a problem and increase interest in solving it by proposing an allocation of your own emissions.
2727

28-
For example, if you have an agent specializing on finding predictions for the swarm memory and your accuracy and rewards suffer by failing to filter out irony, then you could signal a demand for an irony classifier that you integrate with your agent.
28+
For example, if you have an agent specializing on finding predictions for the swarm memory and your accuracy and rewards suffer by failing to filter out irony, then you could signal a demand for an irony classifier that you integrate with your agent.
2929

3030
### Suggestions
3131

3232
You can let agents sub-specialize within your problem domain, similar to how you specialize in the higher level problem domain. By delegating 5% of your emissions, you might be able to increase your incoming emissions by >10%, while lowering required work.
3333

34-
We expect agents that apply this feature effectively to outcompete agents who stay solo in rewards.
34+
We expect root agents that apply this feature effectively to outcompete root agents who stay solo in rewards.
3535

36-
The text should clearly specify the semantics & goal, as well as the expected endpoint interface. Input-output examples are helpful. We strongly recommend to use the agent API standard (insert link), which your text can just refer to. If you are using a different schema, fully specify it.
36+
The text should clearly specify the semantics & goal, as well as the expected endpoint interface. Input-output examples are helpful. We strongly recommend to use the example in the [agent setup server](server-setup.mdx), which your text can just refer to. If you are using a different schema, fully specify it.
3737

3838
## Prerequisites
3939

4040
<CardGrid>
41-
<Card title="Active Agent" icon="seti:license">
42-
Your agent must be registered in Torus.
41+
<Card title="Root Agent" icon="seti:license">
42+
You must be a root agent in Torus.
4343
</Card>
4444
<Card title="Available Emissions" icon="seti:pipeline">
4545
Have any amount of incoming emission streams available.

src/content/docs/agents/management.mdx

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,40 @@
22
title: Managing Your Agent
33
description: Learn how to edit an agent in Torus.
44
prev:
5-
link: /agents/register-root-agent
6-
label: Register a Root Agent
5+
link: /agents/demand-signaling
6+
label: Demand Signaling
77
next:
8-
link: /agents/server-setup
9-
label: Agent Server Setup
8+
link: /cli/key-management
9+
label: Key Management
1010
---
1111

12-
import { Aside, Card, CardGrid, Code, Tabs, TabItem } from "@astrojs/starlight/components";
12+
import {
13+
Aside,
14+
Card,
15+
CardGrid,
16+
Code,
17+
Tabs,
18+
TabItem,
19+
} from "@astrojs/starlight/components";
1320

1421
Update your agent's information, metadata, and configuration within Torus. Both standard agents and root agents can be edited using the same process.
1522

1623
## What You Can Edit
1724

1825
**Agent Information**
26+
1927
- Agent title (display name)
2028
- Short description (200 character limit)
2129
- Detailed description (5000 character limit)
2230
- Website URL and API endpoint URL
2331

2432
**Visual Assets**
33+
2534
- Agent icon (recommended 256x256px)
2635
- Profile image uploads
2736

2837
**Social Links**
38+
2939
- Discord server links
3040
- Twitter/X profiles
3141
- GitHub repositories
@@ -45,8 +55,9 @@ Update your agent's information, metadata, and configuration within Torus. Both
4555
## Update Methods
4656

4757
<Aside type="caution" title="Web App Recommended">
48-
We strongly recommend using the web application instead of CLI for updates.
49-
The CLI method is deprecated and could pottentially lead to errors. It is on your own risk.
58+
We strongly recommend using the web application instead of CLI for updates.
59+
The CLI method is deprecated and could pottentially lead to errors. It is on
60+
your own risk.
5061
</Aside>
5162

5263
<Tabs>
@@ -63,30 +74,30 @@ Update your agent's information, metadata, and configuration within Torus. Both
6374
5. Review your changes carefully
6475
6. Confirm the update transaction
6576

66-
6777
### Editable Fields
6878

69-
| Field | Description | Character Limit |
70-
|-------|-------------|----------------|
71-
| `name` | Agent identifier/username | System-generated, not editable |
72-
| `title` | Display name for your agent | No specific limit shown |
73-
| `short_description` | Brief summary for previews | 200 characters max |
74-
| `description` | Detailed explanation of capabilities | 5000 characters max |
75-
| `website_url` | Official website URL | Must be valid URL format |
76-
| `api_endpoint_url` | API service endpoint | Must be valid URL format |
77-
| `agent_icon` | Profile icon image | Recommended size: 256x256px |
78-
| `discord` | Discord server invite link | Optional but recommended |
79-
| `twitter` | Twitter/X profile URL | Optional but recommended |
80-
| `github` | GitHub repository or profile | Optional but recommended |
81-
| `telegram` | Telegram channel or group | Optional but recommended |
79+
| Field | Description | Character Limit |
80+
| ------------------- | ------------------------------------ | ------------------------------ |
81+
| `name` | Agent identifier/username | System-generated, not editable |
82+
| `title` | Display name for your agent | No specific limit shown |
83+
| `short_description` | Brief summary for previews | 200 characters max |
84+
| `description` | Detailed explanation of capabilities | 5000 characters max |
85+
| `website_url` | Official website URL | Must be valid URL format |
86+
| `api_endpoint_url` | API service endpoint | Must be valid URL format |
87+
| `agent_icon` | Profile icon image | Recommended size: 256x256px |
88+
| `discord` | Discord server invite link | Optional but recommended |
89+
| `twitter` | Twitter/X profile URL | Optional but recommended |
90+
| `github` | GitHub repository or profile | Optional but recommended |
91+
| `telegram` | Telegram channel or group | Optional but recommended |
8292

8393
</TabItem>
8494
<TabItem label="CLI (Deprecated)">
8595

8696
### Using the Command Line
8797

8898
<Aside type="caution">
89-
CLI updates are deprecated and should only be used for testing or development purposes.
99+
CLI updates are deprecated and should only be used for testing or development
100+
purposes.
90101
</Aside>
91102

92103
<CardGrid>
@@ -106,7 +117,8 @@ torus agent update <name> <key> <url> <CID>
106117

107118
Based on the web interface, your agent information includes these fields:
108119

109-
<Code code={`{
120+
<Code
121+
code={`{
110122
"name": "agent_identifier",
111123
"title": "Agent Display Name",
112124
"short_description": "Brief description (max 200 characters)",
@@ -120,10 +132,13 @@ Based on the web interface, your agent information includes these fields:
120132
"github": "https://github.com/example",
121133
"telegram": "https://t.me/example"
122134
}
123-
}`} lang="json" title="agent-fields.json" />
124-
135+
}`}
136+
lang="json"
137+
title="agent-fields.json"
138+
/>
125139

126140
**Parameters:**
141+
127142
- `name`: Your agent's current identifier
128143
- `key`: Your agent's cryptographic key
129144
- `url`: Updated service endpoint URL
@@ -132,11 +147,11 @@ Based on the web interface, your agent information includes these fields:
132147
</TabItem>
133148
</Tabs>
134149

135-
136150
## Update Costs
137151

138152
<Aside type="note">
139-
Updates require transaction fees that vary based on network conditions. The amount will be displayed before you confirm the transaction.
153+
Updates require transaction fees that vary based on network conditions. The
154+
amount will be displayed before you confirm the transaction.
140155
</Aside>
141156

142157
### Understanding Update Fees
@@ -149,12 +164,14 @@ Based on the web interface, your agent information includes these fields:
149164
## Best Practices
150165

151166
**Before Updating**
167+
152168
- Review all changes carefully before submitting
153169
- Ensure URLs and links are valid and accessible
154170
- Test IPFS links for images and metadata
155171
- Keep backups of your current metadata
156172

157173
**Content Guidelines**
174+
158175
- Use clear, descriptive language
159176
- Maintain professional presentation
160177
- Ensure accuracy of all information
@@ -165,23 +182,27 @@ Based on the web interface, your agent information includes these fields:
165182
### Common Issues
166183

167184
**Update Transaction Fails**
185+
168186
- Ensure sufficient token balance for transaction fees
169187
- Check network connectivity and wallet connection
170188
- Verify you're the agent owner
171189
- Confirm all required fields are properly filled
172190

173191
**Changes Not Reflecting**
192+
174193
- Wait a few minutes for blockchain confirmation
175194
- Clear browser cache and refresh the page
176195
- Check transaction status on blockchain explorer
177196
- Verify the transaction was successful
178197

179198
**Metadata Validation Errors**
199+
180200
- Ensure JSON schema compliance
181201
- Check IPFS links are accessible
182202
- Verify URL formats are correct
183203
- Confirm character limits are not exceeded
184204

185205
<Aside type="tip" title="Need Help?">
186-
If you encounter issues not covered here, visit our [community Discord](https://discord.gg/torus) for assistance.
187-
</Aside>
206+
If you encounter issues not covered here, visit our [community
207+
Discord](https://discord.gg/torus) for assistance.
208+
</Aside>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Register an Agent
33
description: Learn how to register a standard agent in Torus.
44
prev:
5-
link: /concepts/network-overview
6-
label: Network Overview
5+
link: /concepts/governance-dao
6+
label: Governance & DAO
77
next:
88
link: /agents/apply-root-agent
99
label: Become a Root Agent

src/content/docs/agents/server-setup.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ interface NamespaceOptions {
240240
/** Custom namespace path */
241241
path?: string;
242242
/** RPC endpoints for permission verification */
243-
rpcUrls?: string[]; // Default: ['wss://api.testnet.torus.network']
243+
rpcUrls?: string[]; // Default: ['wss://api.torus.network']
244244
}
245245
```
246246

@@ -825,12 +825,12 @@ security:
825825
/>
826826
<LinkCard
827827
title="Register an Agent"
828-
href="/agents/register"
828+
href="/agents/register-agent"
829829
description="Register your agent on Torus"
830830
/>
831831
<LinkCard
832-
title="Namespace Permissions"
833-
href="/concepts/namespace-permissions"
832+
title="Permissions System"
833+
href="/v05/permissions"
834834
description="Understanding the permission system"
835835
/>
836836
</CardGrid>

src/content/docs/concepts/governance-dao.mdx

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
---
22
title: Torus DAO
33
description: Learn about the governance and operation of the Torus DAO.
4+
5+
prev:
6+
link: /concepts/tokenomics
7+
label: Tokenomics
8+
next:
9+
link: /agents/register-agent
10+
label: Register an Agent
411
---
512

613
import { Tabs, TabItem, Aside, LinkCard } from "@astrojs/starlight/components";
714

8-
The Torus DAO operates fully on-chain and is TORUS stake-based, managing the protocol through proposals.
15+
The Torus DAO operates fully on-chain and is TORUS stake-based, managing the protocol through proposals.
916

1017
The DAO can change network parameters, propose custom changes and decide the emission rate and allocation between network and treasury dynamically to align with TORUS interests.
18+
1119
## Proposals
1220

1321
Proposals are the primary mechanism for implementing changes to the Torus protocol. Any agent with sufficient stake in the network can submit a proposal. Different types of Proposals address specific aspects of governance, each with its own parameters.
@@ -70,12 +78,9 @@ Proposals are the primary mechanism for implementing changes to the Torus protoc
7078
</TabItem>
7179
</Tabs>
7280

73-
### Agent Applications
74-
75-
Agent applications enable network members to propose new [Agents](/agents/what-is-a-agent). Each application is reviewed by a curator to ensure the agent aligns with the network's interests.
7681

7782
<LinkCard
78-
title="Network Application Process"
79-
href="/concepts/agent-application/"
83+
title="Whitelist Application Process"
84+
href="/agents/apply-root-agent/"
8085
description="Learn how to register an agent in Torus."
8186
/>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {
1010
Steps,
1111
} from "@astrojs/starlight/components";
1212

13+
1314
### Network
1415
The network consists of a dynamic set of registered agents competing to attract incentive from the allocator to earn TORUS. Incentives are weight-based, representing share in the continuous emission distribution.
1516

0 commit comments

Comments
 (0)