Skip to content

Commit f565ed4

Browse files
committed
Refactor configuration slugs for guides; add RedText component in various how-to guides for enhanced readability and emphasis
1 parent 46ddb2c commit f565ed4

20 files changed

+214
-105
lines changed

astro.config.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ export default defineConfig({
7878
label: "Holders",
7979
collapsed: false,
8080
items: [
81-
{ label: "Setup a Wallet", slug: "how-to-guides/participants/setup-a-wallet" },
82-
{ label: "Bridge from Base", slug: "how-to-guides/participants/bridge-from-base" },
83-
{ label: "Stake your Torus", slug: "how-to-guides/participants/stake-your-torus" },
81+
{ label: "Setup a Wallet", slug: "how-to-guides/holders/setup-a-wallet" },
82+
{ label: "Bridge from Base", slug: "how-to-guides/holders/bridge-from-base" },
83+
{ label: "Stake your Torus", slug: "how-to-guides/holders/stake-your-torus" },
8484
],
8585
},
8686
{

src/components/RedText.astro

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
export interface Props {
3+
variant?: 'attention' | 'light' | 'soft';
4+
class?: string;
5+
}
6+
7+
const { variant = 'light', class: className = '' } = Astro.props;
8+
9+
const variantClasses = {
10+
attention: 'text-red-attention',
11+
light: 'text-red-light',
12+
soft: 'text-red-soft'
13+
};
14+
15+
const redClass = variantClasses[variant];
16+
---
17+
18+
<span class={`${redClass} ${className}`} style="display: inline;"><slot /></span>

src/content/docs/development/web/overview-and-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The ecosystem is built using a monorepo with [Turborepo](https://turbo.build/rep
1818

1919
<Aside type="tip">
2020
To access environments pointing to the testnet nodes, add the `.testnet`
21-
subdomain to the URL, eg. `https://allocator.testnet.torus.network/`
21+
subdomain to the URL, eg. `https://portal.testnet.torus.network/root-allocator`
2222
</Aside>
2323

2424
## Prerequisites

src/content/docs/development/web/querying-data.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Learn how to query the stake weight between keys
66
import { CardGrid, LinkCard, Aside } from "@astrojs/starlight/components";
77

88
Our API allows you to retrieve information about the stake allocation between keys and agents.
9-
You can query this data by making a GET request to: `https://allocator.torus.network/api/allocated-weight`.
9+
You can query this data by making a GET request to: `https://portal.torus.network/api/allocated-weight`.
1010

1111
## API Response Format
1212

@@ -29,12 +29,12 @@ The API response has the following structure:
2929

3030
To filter the response for a specific allocating key, append the userKey query parameter to the API endpoint:
3131

32-
```allocator.torus.network/api/allocated-weight?userKey=<SS58Address>```
32+
```portal.torus.network/api/allocated-weight?userKey=<SS58Address>```
3333
- Filter by Agent Key
3434

3535
To filter the response for specific agents, append the agentKey query parameter to the API endpoint:
3636

37-
```allocator.torus.network/api/allocated-weight?agentKey=<SS58Address>```
37+
```portal.torus.network/api/allocated-weight?agentKey=<SS58Address>```
3838

3939

4040
<Aside type="note">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The burn mechanism maintains network quality by creating economic barriers to sp
3838

3939
### Discovery and Capabilities
4040

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

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
CardGrid,
1010
Card
1111
} from "@astrojs/starlight/components";
12+
import RedText from '/src/components/RedText.astro';
1213

1314
In this guide, we'll **create a demand signal** to express your need for specialized capabilities from other agents.
1415

@@ -35,7 +36,7 @@ Signaling demand allows you to delegate part of your emissions to agents who can
3536
</Card>
3637
<Card title="Available Emission Allocation" icon="seti:license">
3738
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/participants/stake-your-torus/).
39+
You can find a [guide on how to stake TORUS here](https://docs.torus.network/how-to-guides/holders/stake-your-torus/).
3940
</Card>
4041
</CardGrid>
4142

@@ -48,11 +49,11 @@ Signaling demand allows you to delegate part of your emissions to agents who can
4849

4950

5051
2. **Connect your Torus wallet**
51-
Connect the wallet that owns the agent you want to signal from.
52+
Connect the <RedText variant="light">wallet that owns the agent</RedText> you want to signal from.
5253

53-
3. **Fill in the signal details:**
54-
55-
Signals allow agents to express their demand for specialized capabilities in both technical and economic terms. Here's an **example** of what a signal might look like:
54+
3. **Fill in the signal details**
55+
Signals allow agents to express their demand for specialized capabilities in both technical and economic terms.
56+
Here's an <RedText variant="light">example of what a signal could look like</RedText>:
5657

5758
```
5859
Title: Short, descriptive name for the capability you need
@@ -90,10 +91,10 @@ Signaling demand allows you to delegate part of your emissions to agents who can
9091
</Aside>
9192

9293
4. **Review and publish the signal**
93-
Double-check your details and publish to make it discoverable.
94+
Double-check your details and <RedText variant="light">publish to make it discoverable</RedText>.
9495

9596
5. **All Done**
96-
Your demand signal is now visible in the Torus graph and signal marketplace for other agents to discover.
97+
Your demand signal is now visible in the Torus graph and [signal marketplace for other agents](https://portal.torus.network/signals/signal-list) to discover.
9798

9899
</Steps>
99100

src/content/docs/how-to-guides/builders/delegate-emission-streams.mdx

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
Tabs,
1212
TabItem
1313
} from "@astrojs/starlight/components";
14+
import RedText from '/src/components/RedText.astro';
1415

1516
In this guide, we'll set up **emission permissions** to delegate portions of your token streams to other agents.
1617
This enables economic coordination, agent hiring, and revenue sharing structures.
@@ -102,7 +103,7 @@ Emission permissions work with **stream identity preservation**:
102103
Verify all details before submitting.
103104

104105
7. **Submit emission permission**
105-
Sign the transaction to create the delegation on-chain.
106+
<RedText variant="light">Sign the transaction</RedText> to create the delegation on-chain.
106107

107108
8. **Monitor delegation**
108109
Track delegation status in the Portal dashboard.
@@ -117,15 +118,15 @@ Emission permissions work with **stream identity preservation**:
117118
### Stream-Based Delegation
118119

119120
**Select Streams**: Choose which emission streams to delegate
120-
- View all your active streams with their StreamIds
121-
- See current flow rates and sources
122-
- Select specific streams for delegation
121+
- View all your <RedText variant="light">active streams with their StreamIds</RedText>
122+
- See <RedText variant="light">current flow rates and sources</RedText>
123+
- Select <RedText variant="light">specific streams for delegation</RedText>
123124

124125
**Set Percentages**: Define allocation per stream
125126
```
126-
Stream A (Staking): 25% → Agent Bob
127-
Stream B (Fees): 50% → Agent Charlie
128-
Stream C (Root): 10% → Agent Dave
127+
Stream A (Staking): <RedText variant="light">25%</RedText> → Agent Bob
128+
Stream B (Fees): <RedText variant="light">50%</RedText> → Agent Charlie
129+
Stream C (Root): <RedText variant="light">10%</RedText> → Agent Dave
129130
```
130131

131132
**Safety Validation**: System ensures totals don't exceed 100% per stream
@@ -136,9 +137,9 @@ Stream C (Root): 10% → Agent Dave
136137
### Fixed Amount Delegation
137138

138139
**Amount**: Specify TORUS amount per period
139-
- Daily allocation: `100 TORUS/day`
140-
- Weekly allocation: `700 TORUS/week`
141-
- Monthly allocation: `3000 TORUS/month`
140+
- Daily allocation: <RedText variant="light">`100 TORUS/day`</RedText>
141+
- Weekly allocation: <RedText variant="light">`700 TORUS/week`</RedText>
142+
- Monthly allocation: <RedText variant="light">`3000 TORUS/month`</RedText>
142143

143144
**Payment Schedule**: Define distribution frequency
144145
- Real-time (continuous)
@@ -147,9 +148,9 @@ Stream C (Root): 10% → Agent Dave
147148
- Monthly distributions
148149

149150
**Source Priority**: Order which streams fund fixed payments
150-
1. Staking rewards (priority 1)
151-
2. Delegation fees (priority 2)
152-
3. Other streams (priority 3)
151+
1. <RedText variant="light">Staking rewards</RedText> (priority 1)
152+
2. <RedText variant="light">Delegation fees</RedText> (priority 2)
153+
3. <RedText variant="light">Other streams</RedText> (priority 3)
153154

154155
</TabItem>
155156
</Tabs>

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ import {
1212

1313

1414
import ClickableImage from '/src/components/ClickableImage.astro';
15+
import RedText from '/src/components/RedText.astro';
1516
import registeredAgents from '/public/images/how-to-guide/register-an-agent/registered-agent-on-allocator-page.png';
1617
import editAgent from '/public/images/how-to-guide/edit-your-agent/allocator-card-edit-agent.png';
1718
import toastExample from '/public/images/how-to-guide/edit-your-agent/allocator-success-toast.png';
1819

1920

2021
In this guide, we'll walk through the process of **editing your Agent information** with the Torus Allocator.
21-
Both the **Registered Agent** and **Root Agent** can edit their information. Just make sure to use the proper filter on the Allocator Page.
22+
Both the **Registered Agent** and **Root Agent** can edit their information. <RedText variant="light">Just make sure to use the proper filter on the Allocator tab</RedText>.
2223
In this guide we will be editing the information of a **Registered Agent**.
2324

2425
#### Why edit your agent?
@@ -41,11 +42,11 @@ and ensures your agent represents your current capabilities and offerings.
4142
<CardGrid>
4243
<Card title="Torus Wallet" icon="seti:license">
4344
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/participants/setup-a-wallet/).
45+
You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/).
4546
</Card>
4647
<Card title="Torus Balance" icon="seti:shell">
47-
Check your balance in the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees.
48-
You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/bridge-to-base/).
48+
Check your balance in the [Torus Wallet](https://wallet.torus.network) and ensure you have enough **Free Balance** to cover the registration fees.
49+
You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/).
4950
</Card>
5051
<Card title="Registered or Root Agent" icon="seti:license">
5152
You must have a Registered or Root Agent to edit your information.
@@ -56,13 +57,13 @@ and ensures your agent represents your current capabilities and offerings.
5657
## Edit your Agent Information
5758

5859
<Steps>
59-
1. **Find your Agent in the [Allocator App](https://allocator.torus.network/)**
60+
1. **Find your Agent in the [Allocator Tab](https://portal.torus.network/root-allocator)**
6061
You can either search for your Agent by name or by the address.
6162

62-
<ClickableImage src={registeredAgents} alt="Allocator Page" />
63+
<ClickableImage src={registeredAgents} alt="Allocator tab" />
6364

6465
2. **Click on the card of your Agent**
65-
The edit is in the Detailed View of the Agent.
66+
The edit is in the **Detailed View** of the Agent.
6667
<ClickableImage src={editAgent} alt="Edit Agent" />
6768

6869
3. **Edit the information and Submit**
@@ -81,12 +82,12 @@ and ensures your agent represents your current capabilities and offerings.
8182
- Telegram
8283
```
8384
4. **Sign the Transaction in the SubWallet and Wait for the Confirmation**
84-
You will be prompted by SubWallet to sign the on-chain transaction.
85-
Once confirmed, a toast notification will appear to indicate that your allocation was successful.
85+
You will be prompted by <RedText variant="light">SubWallet to sign the on-chain transaction</RedText>.
86+
Once confirmed, a notification will appear to indicate that your allocation was successful.
8687
<ClickableImage src={toastExample} alt="Allocator Success Toast" />
8788

8889
5. **All Done**
89-
You can now see your updated information in the Allocator App.
90+
You can now see your updated information in the [Allocator Tab](https://portal.torus.network/root-allocator).
9091

9192

9293
</Steps>
@@ -95,7 +96,7 @@ and ensures your agent represents your current capabilities and offerings.
9596

9697
After updating your agent information:
9798

98-
- **Monitor your presence**: Check how your agent appears on the [Allocator page](https://allocator.torus.network/)
99+
- **Monitor your presence**: Check how your agent appears on the [Allocator tab](https://portal.torus.network/root-allocator)
99100
- **Stay up to date**: Keep your information updated to match the latest changes
100101
- **Build capabilities**: Set up an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide services
101102

src/content/docs/how-to-guides/builders/manage-capabilities.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
} from "@astrojs/starlight/components";
1212

1313
import ClickableImage from '/src/components/ClickableImage.astro';
14+
import RedText from '/src/components/RedText.astro';
1415
import confirmCapability from '/public/images/how-to-guide/manage-capabilities/create-capability-confirm-information.png';
1516

1617
In this guide, we'll walk through **managing capabilities** in the Torus control space.
@@ -37,7 +38,7 @@ By removing outdated or unused capabilities, you reduce the attack surface and k
3738
<CardGrid>
3839
<Card title="Registered Agent" icon="seti:license">
3940
You must have a registered agent on Torus.
40-
Follow the [agent registration guide](register-an-agent) if needed.
41+
Follow the [agent registration guide](https://docs.torus.network/how-to-guides/builders/register-an-agent/) if needed.
4142
</Card>
4243
<Card title="Torus Balance" icon="seti:shell">
4344
Ensure you have enough TORUS to cover capability registration and deposit fees.
@@ -62,7 +63,7 @@ By removing outdated or unused capabilities, you reduce the attack surface and k
6263
- The `capability-path` is the custom route you define (e.g. `tokens`, `profile_data`, etc.).
6364

6465
<Aside type="note">
65-
Capability paths can only contain **lowercase letters**, **numbers**, **hyphens**, and **underscores**.
66+
Capability paths can only contain <RedText variant="light">**lowercase letters**</RedText>, <RedText variant="light">**numbers**</RedText>, <RedText variant="light">**hyphens**</RedText>, and <RedText variant="light">**underscores**</RedText>.
6667
You **do not** need to type the agent name or method — they are handled by the UI.
6768

6869
**Examples:**
@@ -94,13 +95,13 @@ By removing outdated or unused capabilities, you reduce the attack surface and k
9495

9596
5. **Review information, Submit and Sign the Transaction**
9697
Review the capability path in the **Full Capability Path** field.
97-
If everything is correct, click **Create Capability**.
98-
Open the SubWallet extension and sign the transaction.
98+
If everything is correct, click <RedText variant="light">**Create Capability**</RedText>.
99+
Open the SubWallet extension and <RedText variant="light">sign the transaction</RedText>.
99100
<ClickableImage src={confirmCapability} alt="Confirm Capability" />
100101

101102
6. **All Done**
102103
You've now successfully created a capability on the Torus control space.
103-
Now you can delegatepermissions to it.
104+
Now you can delegate permissions to it.
104105
</Steps>
105106

106107
### Delete a Capability path

src/content/docs/how-to-guides/builders/manage-permissions.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
Tabs,
1212
TabItem
1313
} from "@astrojs/starlight/components";
14+
import RedText from '/src/components/RedText.astro';
1415

1516
In this guide, we'll walk through **managing permissions** in Torus's recursive delegation system.
1617
Permissions enable fine-grained control over emission distribution and capability access between agents.

0 commit comments

Comments
 (0)