Skip to content

Commit ef6f417

Browse files
committed
refactor agent documentation: replace generic terms with specific "Torus" references for clarity and consistency across guides
1 parent 553df2e commit ef6f417

18 files changed

+169
-90
lines changed

astro.config.mjs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ export default defineConfig({
8282
{ label: "Balance Operations", slug: "cli/balance-operations" },
8383
],
8484
},
85-
{
86-
label: "Web Apps",
87-
items: [
88-
{ label: "Torus Portal", slug: "web-apps/torus-portal" },
89-
{ label: "Torus Allocator", slug: "web-apps/torus-allocator" },
90-
{ label: "Torus Wallet", slug: "web-apps/torus-wallet" },
91-
{ label: "Torus DAO", slug: "web-apps/torus-dao" },
92-
],
93-
},
85+
// {
86+
// label: "Web Apps",
87+
// items: [
88+
// { label: "Torus Portal", slug: "web-apps/torus-portal" },
89+
// { label: "Torus Allocator", slug: "web-apps/torus-allocator" },
90+
// { label: "Torus Wallet", slug: "web-apps/torus-wallet" },
91+
// { label: "Torus DAO", slug: "web-apps/torus-dao" },
92+
// ],
93+
// },
9494
{
9595
label: "Development",
9696
items: [

src/content/docs/explanations/agent-client.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,21 @@ import {
77
Aside
88
} from "@astrojs/starlight/components";
99

10-
## Agent Client Architecture
1110

12-
Agent clients in Torus provide a standardized way to interact with agent servers across the network. They handle authentication automatically and provide consistent interfaces for capability discovery and usage.
11+
Agent clients in Torus provide a standardized way to interact with agent servers across the network.
12+
They handle authentication automatically and provide consistent interfaces for capability discovery and usage.
1313

1414
### Authentication Flow
1515

16-
Agent clients use the caller's keypair to generate JWT tokens signed with SR25519 signatures. This creates a trustless authentication system where agent servers can verify the caller's identity without prior coordination or shared secrets.
16+
Agent clients use the caller's keypair to generate JWT tokens signed with SR25519 signatures.
17+
This creates a trustless authentication system where agent servers can verify the caller's identity without prior coordination or shared secrets.
1718

1819
Each API call includes the caller's cryptographic identity, enabling fine-grained permission controls based on the Torus namespace system.
1920

2021
### Communication Patterns
2122

22-
Clients provide structured success/error responses with consistent error handling across all agent interactions. This standardization enables reliable capability composition and error propagation in complex agent workflows.
23+
Clients provide structured success/error responses with consistent error handling across all agent interactions.
24+
This standardization enables reliable capability composition and error propagation in complex agent workflows.
2325

2426
The client abstracts HTTP complexities while maintaining type safety and enabling automatic retries, circuit breaking, and other resilience patterns for distributed agent communication.
2527

src/content/docs/explanations/agent-editing.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,24 @@ import {
1212
TabItem,
1313
} from "@astrojs/starlight/components";
1414

15-
## Agent Editing System
1615

17-
Agent editing in Torus allows agents to update their metadata, endpoints, and social connections after initial registration. Only the original registering wallet maintains editing rights, ensuring agent integrity.
16+
Agent editing in Torus allows agents to update their metadata, endpoints, and social connections after initial registration.
17+
Only the original registering wallet maintains editing rights, ensuring agent integrity.
1818

19-
Agents can modify display information (titles, descriptions), service endpoints, visual assets, and social media links. Core identifiers and cryptographic associations remain immutable once set during registration.
19+
Agents can modify display information (titles, descriptions), service endpoints, visual assets, and social media links.
20+
Core identifiers and cryptographic associations remain immutable once set during registration.
2021

2122
### Update Economics
2223

23-
Updates require only standard transaction fees - no token burning like initial registration. This minimal cost structure encourages agents to maintain current, accurate information while preventing spam through basic network fees.
24+
Updates require only standard transaction fees - no token burning like initial registration.
25+
This minimal cost structure encourages agents to maintain current, accurate information while preventing spam through basic network fees.
2426

2527
Regular updates improve discoverability and signal ongoing agent activity, building trust within the Torus ecosystem.
2628

2729
### Storage Architecture
2830

29-
Agent information uses a hybrid model: core identifiers and ownership on-chain, with extended metadata and rich content stored off-chain via IPFS. This balances blockchain immutability with the flexibility needed for comprehensive agent profiles.
31+
Agent information uses a hybrid model: core identifiers and ownership on-chain, with extended metadata and rich content stored off-chain via IPFS.
32+
This balances blockchain immutability with the flexibility needed for comprehensive agent profiles.
3033

3134
### Related Concepts
3235

src/content/docs/explanations/agent-registration.mdx

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

22-
## Agent Registration System
2322

24-
Agent registration in Torus creates discoverable entities that can receive, create, and delegate permissions within the network. Registration is immediate with no approval required, but involves burning tokens to prevent spam.
23+
Agent registration in Torus creates discoverable entities that can receive, create, and delegate permissions within the network.
24+
Registration is immediate with no approval required, but involves burning tokens to prevent spam.
2525

2626
### Registration Economics
2727

@@ -36,7 +36,9 @@ The burn mechanism maintains network quality by creating economic barriers to sp
3636

3737
### Discovery and Capabilities
3838

39-
Registered agents become discoverable through the public agent registry and can be viewed on the [Allocator page](https://allocator.torus.network/). They can participate in the permission system, create named capabilities for other agents to invoke, and engage in governance proposals. Agent metadata is stored off-chain via IPFS but referenced on-chain through content hashes.
39+
Registered agents become discoverable through the public agent registry and can be viewed on the [Allocator page](https://allocator.torus.network/).
40+
They can participate in the permission system, create named capabilities for other agents to invoke, and engage in governance proposals.
41+
Agent metadata is stored off-chain via IPFS but referenced on-chain through content hashes.
4042

4143
### Related Concepts
4244

src/content/docs/explanations/agent-server.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,24 @@ import {
77
Aside
88
} from "@astrojs/starlight/components";
99

10-
## Agent Server Architecture
1110

12-
Agent servers in Torus enable agents to expose APIs that other agents can discover and interact with. They use blockchain-based authentication and automatic documentation generation to facilitate secure capability sharing across the network.
11+
Agent servers in Torus enable agents to expose APIs that other agents can discover and interact with.
12+
They use blockchain-based authentication and automatic documentation generation to facilitate secure capability sharing across the network.
1313

1414
### Authentication Model
1515

16-
Agent servers use SR25519 signature-based JWT authentication, where each API call is authenticated using the caller's cryptographic identity. This eliminates traditional API keys while ensuring requests are verifiable on-chain.
16+
Agent servers use SR25519 signature-based JWT authentication, where each API call is authenticated using the caller's cryptographic identity.
17+
This eliminates traditional API keys while ensuring requests are verifiable on-chain.
1718

1819
Namespace permissions control access to specific capabilities, allowing fine-grained authorization based on the Torus permission system.
1920

2021
### Documentation and Discovery
2122

22-
Servers automatically generate OpenAPI documentation, making capabilities discoverable and self-documenting. This enables agents to understand available endpoints, required inputs, and expected outputs without manual coordination.
23+
Servers automatically generate OpenAPI documentation, making capabilities discoverable and self-documenting.
24+
This enables agents to understand available endpoints, required inputs, and expected outputs without manual coordination.
2325

24-
The integration of Hono for HTTP routing and Zod for input validation ensures type-safe APIs with automatic schema validation, maintaining consistency between TypeScript types, runtime validation, and generated documentation.
26+
The integration of Hono for HTTP routing and Zod for input validation ensures type-safe APIs with automatic schema validation,
27+
maintaining consistency between TypeScript types, runtime validation, and generated documentation.
2528

2629
### Related Concepts
2730

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ import {
1515
CardGrid,
1616
} from "@astrojs/starlight/components";
1717

18-
## Capability Demand Signaling System
1918

20-
The [Create Signal feature on the Portal](https://portal.torus.network/signals/create-signal) allows agents to express in a technical and economical way their demand for specialized capabilities from other agents.
19+
The [Create Signal feature on the Portal](https://portal.torus.network/signals/create-signal) allows agents to express in a technical and economical way
20+
their demand for specialized capabilities from other agents.
2121

22-
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.
22+
Standard agents are looking for opportunities to receive emission delegations by providing specialized capabilities.
23+
This means, you can define a problem and increase interest in solving it by proposing an allocation of your own emissions.
2324

24-
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.
25+
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,
26+
then you could signal a demand for an irony classifier that you integrate with your agent.
2527

2628
### Suggestions
2729

src/content/docs/explanations/root-agents.mdx

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

22-
## Root Agent System
2322

24-
Root Agents are DAO-approved agents that receive direct emissions from the stake root and can set network goals around which swarms of agents organize. Unlike standard agents, Root Agents access funding without intermediaries and guide network development in areas of unique expertise.
23+
Root Agents are DAO-approved agents that receive direct emissions from the stake root and can set network goals around which swarms of agents organize.
24+
Unlike standard agents, Root Agents access funding without intermediaries and guide network development in areas of unique expertise.
2525

2626
### DAO Approval Process
2727

28-
Becoming a Root Agent requires DAO member approval through [whitelist applications](https://dao.torus.network/whitelist-applications). Applications need majority approval and are evaluated based on technical capability, unique value proposition, and community standing.
28+
Becoming a Root Agent requires DAO member approval through [whitelist applications](https://dao.torus.network/whitelist-applications).
29+
Applications need majority approval and are evaluated based on technical capability, unique value proposition, and community standing.
2930

3031
Successful applicants demonstrate credible execution, active community participation, and non-overlapping scope that complements existing Root Agents.
3132

src/content/docs/explanations/start-here.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ Whether you're curious about agent systems, DAO processes, or network economics,
2121

2222
Understanding how agents work within Torus:
2323

24-
- [Agent Registration](https://docs.torus.network/explanations/agent-registration/)How agent discovery, costs, and burn mechanisms work
25-
- [Root Agents](https://docs.torus.network/explanations/root-agents/) — DAO approval process, community requirements, and emission access
24+
- [Agent Registration](https://docs.torus.network/explanations/agent-registration/)Registration economics, burn mechanisms, and discovery
25+
- [Root Agents](https://docs.torus.network/explanations/root-agents/) — DAO approval process and direct emission access
2626
- [Agent Server](https://docs.torus.network/explanations/agent-server/) — API architecture, authentication, and capability sharing
2727
- [Agent Client](https://docs.torus.network/explanations/agent-client/) — Communication patterns and authentication flow
28-
- [Agent Editing](https://docs.torus.network/explanations/agent-editing/) — Update mechanics and agent lifecycle
28+
- [Agent Editing](https://docs.torus.network/explanations/agent-editing/) — Update mechanics and storage architecture
29+
- [Demand Signaling](https://docs.torus.network/explanations/demand-signaling/) — Capability coordination and economic incentives
2930

3031
---
3132

@@ -40,13 +41,13 @@ Understanding the core systems that power Torus:
4041

4142
---
4243

43-
## Additional Resources
44+
## Questions Not Covered Here?
4445

45-
Want to dive even deeper? Explore our technical resources:
46+
Can't find the explanation you're looking for? The community is here to help:
4647

47-
- **[Torus Discord](https://discord.gg/torus)**Join technical discussions and ask questions about how things work.
48-
- **[Torus Telegram](https://t.me/torusnetwork)**Community discussions and insights.
49-
- **[Torus Twitter](https://twitter.com/torus_network)**Torus updates and ecosystem developments.
48+
- **[Discord](https://discord.gg/torus)**Technical discussions, support, and announcements
49+
- **[Telegram](https://t.me/torusnetwork)**General chat and announcements
50+
- **[Twitter](https://x.com/torus_network)**Updates and ecosystem news
5051

5152
### Core Projects
5253

src/content/docs/how-to-guides/become-a-root-agent.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,15 @@ Root Agents receive emissions directly from the stake root and can set goals for
100100
</Steps>
101101

102102

103-
## Support and Resources
104-
If you want to understand more about the core differences between a Registered agent and a Whitelisted agent, you can refer to the [Concepts & Terminology](https://docs.torus.network/getting-started/concepts/) section.
105-
You can also get help directly from the community via:
103+
## What's Next?
106104

107-
- [Torus Community Discord](https://discord.gg/torus)
108-
- [Torus Telegram Group](https://t.me/torusnetwork)
105+
After submitting your Root Agent application:
106+
107+
- **Join the community**: Be active in [Discord](https://discord.gg/torus) to share updates about your agent.
108+
- **Understand the process**: Learn about [Root Agent](https://docs.torus.network/explanations/root-agents/) approval criteria and DAO governance
109+
- **Check application status**: Monitor [DAO whitelist applications](https://dao.torus.network/whitelist-applications) for voting progress
110+
111+
Connect with the community:
112+
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
113+
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
114+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news

src/content/docs/how-to-guides/bridge-from-base.mdx

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,10 +137,16 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU
137137
</Steps>
138138

139139

140-
## Support and Resources
141-
By following these steps, you can successfully bridge your tokens between Torus, Torus EVM, and Base.
142-
Holding native TORUS is required to interact with Torus, and currently, this is the only supported method for bridging.
143-
If you need help or have questions, you can reach out through the official community channels:
140+
## What's Next?
144141

145-
- [Torus Community Telegram](https://t.me/torusnetwork)
146-
- [Torus Community Discord](https://discord.gg/torus)
142+
Now that you have TORUS tokens, you can:
143+
144+
- **Start earning rewards**: [Stake your TORUS](https://docs.torus.network/how-to-guides/stake-your-torus/) to support agents and earn emissions
145+
- **Become an agent**: [Register an agent](https://docs.torus.network/how-to-guides/register-an-agent/) to provide services and earn directly
146+
- **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://portal.torus.network/)
147+
- **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/concepts/tokenomics/) and emission mechanisms
148+
149+
Connect with the community:
150+
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
151+
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
152+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news

0 commit comments

Comments
 (0)