Skip to content

Commit 4bf5b91

Browse files
committed
add edit-your-agent guide and images: introduce new documentation for editing agent info and relevant visuals for a complete user experience
1 parent 16f3997 commit 4bf5b91

File tree

6 files changed

+100
-6
lines changed

6 files changed

+100
-6
lines changed

astro.config.mjs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,7 @@ export default defineConfig({
107107
{ label: "Stake your Torus", slug: "how-to-guides/stake-your-torus" },
108108
{ label: "Register an Agent", slug: "how-to-guides/register-an-agent" },
109109
{ label: "Become a Root Agent", slug: "how-to-guides/become-a-root-agent" },
110-
// {
111-
// label: "Setup a wallet",
112-
// slug: "how-to-guides/setup-a-wallet",
113-
// },
110+
{ label: "Edit your Agent", slug: "how-to-guides/edit-your-agent" },
114111
],
115112
},
116113
],
192 KB
Loading
199 KB
Loading
574 KB
Loading
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: Edit your Agent information
3+
description: Bridging from Torus Base all the way to Native Torus on the Torus Network.
4+
---
5+
6+
import {
7+
Steps,
8+
Aside,
9+
CardGrid,
10+
Card
11+
} from "@astrojs/starlight/components";
12+
13+
import ClickableImage from '/src/components/ClickableImage.astro';
14+
import registeredAgents from '/public/images/how-to-guide/register-an-agent/registered-agent-on-allocator-page.png';
15+
import editAgent from '/public/images/how-to-guide/edit-your-agent/allocator-card-edit-agent.png';
16+
import toastExample from '/public/images/how-to-guide/edit-your-agent/allocator-success-toast.png';
17+
18+
19+
In this guide, we’ll walk through the process of **editing your Agent information** with the Torus Allocator.
20+
Both the **Registered Agent** and **Root Agent** can edit their information. Just make sure to use the propper filter on the Allocator Page.
21+
On this Guide we will be editing the information of a **Registered Agent**.
22+
23+
#### What we will accomplish
24+
25+
- Edit your Agent information
26+
27+
<Aside>
28+
⏱️ **Estimated time to complete this guide: 5 minutes**
29+
</Aside>
30+
31+
## Prerequisites
32+
33+
<CardGrid>
34+
<Card title="Torus Wallet" icon="seti:license">
35+
Make sure you have a Torus wallet set up and ready to use.
36+
You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/setup-a-wallet/).
37+
</Card>
38+
<Card title="Torus Balance" icon="seti:shell">
39+
Check your balance on the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees.
40+
You can find a [guide on how to bridge Torus here](https://docs.torus.network/how-to-guides/bridge-to-base/).
41+
</Card>
42+
<Card title="Registered or Root Agent" icon="seti:license">
43+
You must have a Registered or Root Agent to edit your information.
44+
</Card>
45+
</CardGrid>
46+
47+
48+
## Edit your Agent Information
49+
50+
<Steps>
51+
1. **Find your Agent in the [Allocator App](https://allocator.torus.network/)**
52+
You can either search for your Agent by name or by the address.
53+
54+
<ClickableImage src={registeredAgents} alt="Allocator Page" />
55+
56+
2. **Click on the card of your Agent**
57+
The edit is in the Detailed View of the Agent.
58+
<ClickableImage src={editAgent} alt="Edit Agent" />
59+
60+
3. **Edit the information and Submit**
61+
You can edit the following information:
62+
```md
63+
# Short Description
64+
# Description
65+
# Technical Information
66+
- Website URL
67+
- API Endpoint URL
68+
- Agent Icon
69+
# Social Links
70+
- Discord
71+
- Twitter
72+
- GitHub
73+
- Telegram
74+
```
75+
4. **Sign the Transaction in the SubWallet and Wait for the Confirmation**
76+
You will be prompted by SubWallet to sign the on-chain transaction.
77+
Once confirmed, a toast notification will appear to indicate that your allocation was successful.
78+
<ClickableImage src={toastExample} alt="Allocator Success Toast" />
79+
80+
5. **All Done**
81+
You can now see your updated information in the Allocator App.
82+
83+
84+
</Steps>
85+
86+
## Support and Resources
87+
If you want to understand more about what is a Registered Agent or Root Agent, you can relate to the [Concepts & Terminology](https://docs.torus.network/getting-started/concepts/) section.
88+
You can also get help directly from the community via:
89+
90+
- [Torus Community Discord](https://discord.gg/torus)
91+
- [Torus Telegram Group](https://t.me/torusnetwork)

src/content/docs/how-to-guides/register-an-agent.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import registerAnAgentButton from '/public/images/how-to-guide/register-an-agent
1515
import connectWalletOnPortal from '/public/images/how-to-guide/register-an-agent/connect-wallet-on-portal.png';
1616
import filledAgentInformation from '/public/images/how-to-guide/register-an-agent/filled-agent-information.png';
1717
import filledAgentSocials from '/public/images/how-to-guide/register-an-agent/filled-agent-socials.png';
18+
import registeredAgents from '/public/images/how-to-guide/register-an-agent/registered-agent-on-allocator-page.png';
1819

1920
In this guide, we’ll **register an Agent** on the Torus Network.
2021
This is a step-by-step walkthrough of the registration process.
@@ -90,12 +91,17 @@ Registered agents can actively participate in the network by creating permission
9091
When you hover the mouse on the Registration Fee Price, you will see the breakthrough price of the registration fees.
9192

9293
These fees are divided between:
93-
- Network Fee: Fixed 15 Torus Fee. Burned permanently
94+
- Transaction Fee: Variable network fee. Burned permanently
95+
- Agent Registration Fee: Fixed 15 Torus Fee. Burned permanently
9496
- Capability Creation Fee: Fixed 3.29 Torus Fee. Burned permanently
9597
- Capability Deposit: Variable deposit based on the size of the agent name. This value is refunded when the capability is removed.
9698
</Aside>
9799

98-
4. **All Done**
100+
6. **Check your Agent on the [Allocator Page](https://allocator.torus.network/?isWhitelisted=false)**
101+
You should find your agent on the Allocator Page, with the filter of Registered Agents.
102+
<ClickableImage src={registeredAgents} alt="Allocator Page" />
103+
104+
6. **All Done**
99105
You’ve now successfully Registered an Agent on Torus.
100106
You can now participate in the network by creating permissions, capabilities and much more.
101107

0 commit comments

Comments
 (0)