Skip to content

Commit 5536460

Browse files
SipherSipher
committed
update agent documentation: restructure sections for builders and leaders, enhancing hierarchy and clarity in Torus guides
1 parent 529999a commit 5536460

20 files changed

+141
-83
lines changed

‎astro.config.mjs‎

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,28 +37,58 @@ export default defineConfig({
3737
label: "Explanations",
3838
items: [
3939
{ label: "Start Here", slug: "explanations/start-here" },
40-
{ label: "Agent Registration", slug: "explanations/agent-registration" },
41-
{ label: "Root Agents", slug: "explanations/root-agents" },
42-
{ label: "Demand Signaling", slug: "explanations/demand-signaling" },
43-
{ label: "Agent Editing", slug: "explanations/agent-editing" },
44-
{ label: "Agent Server", slug: "explanations/agent-server" },
45-
{ label: "Agent Client", slug: "explanations/agent-client" },
40+
{
41+
label: "Builders",
42+
collapsed: false,
43+
items: [
44+
{ label: "Agent Registration", slug: "explanations/builders/agent-registration" },
45+
{ label: "Agent Server", slug: "explanations/builders/agent-server" },
46+
{ label: "Agent Client", slug: "explanations/builders/agent-client" },
47+
{ label: "Agent Editing", slug: "explanations/builders/agent-editing" },
48+
{ label: "Demand Signaling", slug: "explanations/builders/demand-signaling" },
49+
],
50+
},
51+
{
52+
label: "Leaders",
53+
collapsed: false,
54+
items: [
55+
{ label: "Root Agents", slug: "explanations/root-agents/root-agents" },
56+
],
57+
},
4658
],
4759
},
4860
{
4961
label: "How-to Guides",
5062
items: [
5163
{ label: "Start Here", slug: "how-to-guides/start-here" },
52-
{ label: "Setup a Wallet", slug: "how-to-guides/setup-a-wallet" },
53-
{ label: "Bridge from Base", slug: "how-to-guides/bridge-from-base"},
54-
{ label: "Stake your Torus", slug: "how-to-guides/stake-your-torus" },
55-
{ label: "Register an Agent", slug: "how-to-guides/register-an-agent" },
56-
{ label: "Become a Root Agent", slug: "how-to-guides/become-a-root-agent" },
57-
{ label: "Edit your Agent", slug: "how-to-guides/edit-your-agent" },
58-
{ label: "Create a Signal", slug: "how-to-guides/create-signal" },
59-
{ label: "Setup Agent Server", slug: "how-to-guides/setup-agent-server" },
60-
{ label: "Setup Agent Client", slug: "how-to-guides/setup-agent-client" },
61-
{ label: "Setup CLI", slug: "how-to-guides/setup-cli" },
64+
{
65+
label: "Participants",
66+
collapsed: false,
67+
items: [
68+
{ label: "Setup a Wallet", slug: "how-to-guides/participants/setup-a-wallet" },
69+
{ label: "Bridge from Base", slug: "how-to-guides/participants/bridge-from-base" },
70+
{ label: "Stake your Torus", slug: "how-to-guides/participants/stake-your-torus" },
71+
],
72+
},
73+
{
74+
label: "Builders",
75+
collapsed: false,
76+
items: [
77+
{ label: "Setup CLI", slug: "how-to-guides/builders/setup-cli" },
78+
{ label: "Register an Agent", slug: "how-to-guides/builders/register-an-agent" },
79+
{ label: "Edit your Agent", slug: "how-to-guides/builders/edit-your-agent" },
80+
{ label: "Create a Signal", slug: "how-to-guides/builders/create-signal" },
81+
{ label: "Setup Agent Server", slug: "how-to-guides/builders/setup-agent-server" },
82+
{ label: "Setup Agent Client", slug: "how-to-guides/builders/setup-agent-client" },
83+
],
84+
},
85+
{
86+
label: "Leaders",
87+
collapsed: false,
88+
items: [
89+
{ label: "Become a Root Agent", slug: "how-to-guides/root-agents/become-a-root-agent" },
90+
],
91+
},
6292
],
6393
},
6494
{

src/content/docs/explanations/agent-client.mdx renamed to src/content/docs/explanations/builders/agent-client.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ The client abstracts HTTP complexities while maintaining type safety and enablin
2727

2828
### Related Concepts
2929

30-
- **[Agent Server](https://docs.torus.network/explanations/agent-server/)** - How agents expose APIs
31-
- **[Agent Registration](https://docs.torus.network/explanations/agent-registration/)** - Discovering available agents
32-
- **[Demand Signaling](https://docs.torus.network/explanations/demand-signaling/)** - Finding needed capabilities
30+
- **[Agent Server](https://docs.torus.network/explanations/builders/agent-server/)** - How agents expose APIs
31+
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Discovering available agents
32+
- **[Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/)** - Finding needed capabilities
3333

3434
<Aside type="tip" title="Ready to Setup an Agent Client?">
35-
Follow our [step-by-step guide to setup an agent client](https://docs.torus.network/how-to-guides/setup-agent-client/) for practical instructions.
35+
Follow our [step-by-step guide to setup an agent client](https://docs.torus.network/how-to-guides/builders/setup-agent-client/) for practical instructions.
3636
</Aside>

src/content/docs/explanations/agent-editing.mdx renamed to src/content/docs/explanations/builders/agent-editing.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ This balances blockchain immutability with the flexibility needed for comprehens
3333

3434
### Related Concepts
3535

36-
- **[Agent Registration](https://docs.torus.network/explanations/agent-registration/)** - Initial agent creation and ownership establishment
37-
- **[Demand Signaling](https://docs.torus.network/explanations/demand-signaling/)** - How agents coordinate through signals
38-
- **[Root Agents](https://docs.torus.network/explanations/root-agents/)** - Special considerations for DAO-approved agents
36+
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Initial agent creation and ownership establishment
37+
- **[Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/)** - How agents coordinate through signals
38+
- **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Special considerations for DAO-approved agents
3939

4040
<Aside type="tip" title="Ready to Update Your Agent?">
41-
Follow our [step-by-step guide to edit your agent](https://docs.torus.network/how-to-guides/edit-your-agent/) for practical instructions.
41+
Follow our [step-by-step guide to edit your agent](https://docs.torus.network/how-to-guides/builders/edit-your-agent/) for practical instructions.
4242
</Aside>

src/content/docs/explanations/agent-registration.mdx renamed to src/content/docs/explanations/builders/agent-registration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ Agent metadata is stored off-chain via IPFS but referenced on-chain through cont
3636

3737
### Related Concepts
3838

39-
- **[Root Agents](https://docs.torus.network/explanations/root-agents/)** - Agents that receive emissions directly
39+
- **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Agents that receive emissions directly
4040
- **[Permission System](https://docs.torus.network/v05/permissions/)** - How agents interact and delegate authority
4141
- **[Governance & DAO](https://docs.torus.network/concepts/governance-dao/)** - Understanding DAO decision-making processes
4242

4343
<Aside type="tip" title="Ready to Register?">
44-
Follow our [step-by-step registration guide](https://docs.torus.network/how-to-guides/register-an-agent/) to register your agent.
44+
Follow our [step-by-step registration guide](https://docs.torus.network/how-to-guides/builders/register-an-agent/) to register your agent.
4545
</Aside>

src/content/docs/explanations/agent-server.mdx renamed to src/content/docs/explanations/builders/agent-server.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ maintaining consistency between TypeScript types, runtime validation, and genera
2828

2929
### Related Concepts
3030

31-
- **[Agent Client](https://docs.torus.network/explanations/agent-client/)** - How agents consume server APIs
32-
- **[Agent Registration](https://docs.torus.network/explanations/agent-registration/)** - Making agents discoverable
33-
- **[Demand Signaling](https://docs.torus.network/explanations/demand-signaling/)** - Coordinating capability needs
31+
- **[Agent Client](https://docs.torus.network/explanations/builders/agent-client/)** - How agents consume server APIs
32+
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Making agents discoverable
33+
- **[Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/)** - Coordinating capability needs
3434

3535
<Aside type="tip" title="Ready to Setup an Agent Server?">
36-
Follow our [step-by-step guide to setup an agent server](https://docs.torus.network/how-to-guides/setup-agent-server/) for practical instructions.
36+
Follow our [step-by-step guide to setup an agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) for practical instructions.
3737
</Aside>

src/content/docs/explanations/demand-signaling.mdx renamed to src/content/docs/explanations/builders/demand-signaling.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ By delegating 5% of your emissions, you might be able to increase your incoming
2727
We expect agents that apply this feature effectively to outcompete agents who stay solo in rewards.
2828

2929
The text should clearly specify the semantics & goal, as well as the expected endpoint interface. Input-output examples are helpful.
30-
We strongly recommend to use the example in the [agent setup server](https://docs.torus.network/explanations/agent-server/), which your text can just refer to.
30+
We strongly recommend to use the example in the [agent setup server](https://docs.torus.network/explanations/builders/agent-server/), which your text can just refer to.
3131
If you are using a different schema, fully specify it.
3232

3333
### Related Concepts
3434

35-
- **[Agent Registration](https://docs.torus.network/explanations/agent-registration/)** - How agents become discoverable
36-
- **[Root Agents](https://docs.torus.network/explanations/root-agents/)** - Agents with direct emission access
37-
- **[Agent Server Setup](https://docs.torus.network/explanations/agent-server/)** - Recommended endpoint interface examples
35+
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - How agents become discoverable
36+
- **[Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/)** - Agents with direct emission access
37+
- **[Agent Server Setup](https://docs.torus.network/explanations/builders/agent-server/)** - Recommended endpoint interface examples
3838
- **[Tokenomics](https://docs.torus.network/concepts/tokenomics/)** - Understanding emission mechanisms
3939

4040
<Aside type="tip" title="Ready to Create a Signal?">
41-
Follow our [step-by-step guide to create a signal](https://docs.torus.network/how-to-guides/create-signal/) to start signaling demand for capabilities.
41+
Follow our [step-by-step guide to create a signal](https://docs.torus.network/how-to-guides/builders/create-signal/) to start signaling demand for capabilities.
4242
</Aside>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ Successful applicants demonstrate credible execution, active community participa
3030

3131
### Related Concepts
3232

33-
- **[Agent Registration](https://docs.torus.network/explanations/agent-registration/)** - Technical details of agent registration
33+
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - Technical details of agent registration
3434
- **[Governance & DAO](https://docs.torus.network/concepts/governance-dao/)** - Understanding DAO decision-making processes
3535
- **[Tokenomics](https://docs.torus.network/concepts/tokenomics/)** - How Root Agents access and use network emissions
3636

3737
<Aside type="tip" title="Ready to Apply?">
38-
Follow our [step-by-step application guide](https://docs.torus.network/how-to-guides/become-a-root-agent/) to submit your Root Agent application.
38+
Follow our [step-by-step application guide](https://docs.torus.network/how-to-guides/root-agents/become-a-root-agent/) to submit your Root Agent application.
3939
</Aside>

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

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,23 @@ If you need to accomplish a specific task, check out our [How-to Guides](https:/
1717

1818
These explanations provide deep understanding of how Torus works — the concepts, mechanisms of Torus.
1919

20-
## Agent System
20+
## For Builders (Agents)
2121

22-
Understanding how agents work within Torus:
22+
Understanding how agent systems work within Torus:
2323

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
26-
- [Agent Server](https://docs.torus.network/explanations/agent-server/) — API architecture, authentication, and capability sharing
27-
- [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 storage architecture
29-
- [Demand Signaling](https://docs.torus.network/explanations/demand-signaling/) — Capability coordination and economic incentives
24+
- [Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/) — Registration economics, burn mechanisms, and discovery
25+
- [Agent Server](https://docs.torus.network/explanations/builders/agent-server/) — API architecture, authentication, and capability sharing
26+
- [Agent Client](https://docs.torus.network/explanations/builders/agent-client/) — Communication patterns and authentication flow
27+
- [Agent Editing](https://docs.torus.network/explanations/builders/agent-editing/) — Update mechanics and storage architecture
28+
- [Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/) — Capability coordination and economic incentives
29+
30+
---
31+
32+
## For Root Goal-Setters and Leaders
33+
34+
Understanding governance and leadership systems:
35+
36+
- [Root Agents](https://docs.torus.network/explanations/root-agents/root-agents/) — DAO approval process and direct emission access
3037

3138
---
3239

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Signaling demand allows you to delegate part of your emissions to agents who can
3131
<CardGrid>
3232
<Card title="Agent with Emissions" icon="seti:pipeline">
3333
You need to be an agent with emissions (coming from root or target) to create demand signals.
34-
You can find guides on how to [register an agent](https://docs.torus.network/how-to-guides/register-an-agent/) and [become a root agent](https://docs.torus.network/how-to-guides/become-a-root-agent/).
34+
You can find guides on how to [register an agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) and [become a root agent](https://docs.torus.network/how-to-guides/root-agents/become-a-root-agent/).
3535
</Card>
3636
<Card title="Available Emission Allocation" icon="seti:license">
3737
Have incoming emission streams available to offer as incentive for capability providers.
38-
You can find a [guide on how to stake TORUS here](https://docs.torus.network/how-to-guides/stake-your-torus/).
38+
You can find a [guide on how to stake TORUS here](https://docs.torus.network/how-to-guides/participants/stake-your-torus/).
3939
</Card>
4040
</CardGrid>
4141

@@ -103,7 +103,7 @@ Now that you've created a signal, you might want to:
103103

104104
- **Manage your signals**: Mark as fulfilled or delete them from the [Signal List](https://portal.torus.network/signals/signal-list).
105105
- **Browse the Hypergraph**: Explore agents, capabilities, and signals in the [Hypergraph](https://portal.torus.network/).
106-
- **Build your own capabilities**: Set up an [agent server](https://docs.torus.network/how-to-guides/setup-agent-server/) to provide services
106+
- **Build your own capabilities**: Set up an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide services
107107

108108
Connect with the community:
109109
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ and ensures your agent represents your current capabilities and offerings.
4141
<CardGrid>
4242
<Card title="Torus Wallet" icon="seti:license">
4343
Make sure you have a Torus wallet set up and ready to use.
44-
You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/setup-a-wallet/).
44+
You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/participants/setup-a-wallet/).
4545
</Card>
4646
<Card title="Torus Balance" icon="seti:shell">
4747
Check your balance in the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees.
@@ -97,7 +97,7 @@ After updating your agent information:
9797

9898
- **Monitor your presence**: Check how your agent appears on the [Allocator page](https://allocator.torus.network/)
9999
- **Stay up to date**: Keep your information updated to match the latest changes
100-
- **Build capabilities**: Set up an [agent server](https://docs.torus.network/how-to-guides/setup-agent-server/) to provide services
100+
- **Build capabilities**: Set up an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide services
101101

102102
Connect with the community:
103103
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements

0 commit comments

Comments
 (0)