Skip to content

Commit ebcfd0c

Browse files
SipherSipher
committed
Refactor documentation for v0.6, adding capability permissions, agent management, and emission permissions while improving links and content clarity
1 parent aec3e64 commit ebcfd0c

21 files changed

+396
-284
lines changed

‎astro.config.mjs‎

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,6 @@ export default defineConfig({
3333
label: "Explanations",
3434
items: [
3535
{ label: "Table of Contents", slug: "explanations/table-of-contents" },
36-
{
37-
label: "v0.6",
38-
collapsed: true,
39-
items: [
40-
{ label: "Control Space", slug: "explanations/v06/control-space" },
41-
{ label: "Permission System", slug: "explanations/v06/permissions" },
42-
{
43-
label: "Recursive Delegation",
44-
slug: "explanations/v06/recursive-delegation",
45-
},
46-
{ label: "Emission Permissions", slug: "explanations/v06/emission-permissions" },
47-
{ label: "Governance & DAO", slug: "explanations/v06/governance-dao" },
48-
],
49-
},
5036
{
5137
label: "Holders",
5238
collapsed: true,
@@ -61,10 +47,12 @@ export default defineConfig({
6147
collapsed: true,
6248
items: [
6349
{ label: "Agent Registration", slug: "explanations/builders/agent-registration" },
64-
{ label: "Agent Editing", slug: "explanations/builders/agent-editing" },
50+
{ label: "Agent Managing", slug: "explanations/builders/agent-managing" },
6551
{ label: "Demand Signaling", slug: "explanations/builders/demand-signaling" },
6652
{ label: "Agent Server", slug: "explanations/builders/agent-server" },
6753
{ label: "Agent Client", slug: "explanations/builders/agent-client" },
54+
{ label: "Control Space", slug: "explanations/builders/control-space" },
55+
{ label: "Capability Permissions", slug: "explanations/builders/capability-permissions" },
6856
],
6957
},
7058
{
@@ -73,6 +61,10 @@ export default defineConfig({
7361
items: [
7462
{ label: "Root Agents", slug: "explanations/goal-leaders/root-agents" },
7563
{ label: "Emission Proposals", slug: "explanations/goal-leaders/emission-proposals" },
64+
{ label: "Permission System", slug: "explanations/goal-leaders/permissions" },
65+
{ label: "Recursive Delegation", slug: "explanations/goal-leaders/recursive-delegation" },
66+
{ label: "Emission Permissions", slug: "explanations/goal-leaders/emission-permissions" },
67+
{ label: "Governance & DAO", slug: "explanations/goal-leaders/governance-dao" },
7668
],
7769
},
7870
{ label: "Concepts & Terminology", slug: "explanations/concepts-terminology" },
@@ -96,10 +88,8 @@ export default defineConfig({
9688
collapsed: true,
9789
items: [
9890
{ label: "Register an Agent", slug: "how-to-guides/builders/register-an-agent" },
99-
{ label: "Edit your Agent", slug: "how-to-guides/builders/edit-your-agent" },
91+
{ label: "Manage your Agent", slug: "how-to-guides/builders/manage-your-agent" },
10092
{ label: "Manage Capabilities", slug: "how-to-guides/builders/manage-capabilities" },
101-
{ label: "Manage Permissions", slug: "how-to-guides/builders/manage-permissions" },
102-
{ label: "Recursive Delegation", slug: "how-to-guides/builders/recursive-delegation" },
10393
{ label: "Create a Signal", slug: "how-to-guides/builders/create-signal" },
10494
{ label: "Setup Agent Server", slug: "how-to-guides/builders/setup-agent-server" },
10595
{ label: "Setup Agent Client", slug: "how-to-guides/builders/setup-agent-client" },
@@ -111,6 +101,9 @@ export default defineConfig({
111101
items: [
112102
{ label: "Become a Root Agent", slug: "how-to-guides/goal-leaders/become-a-root-agent" },
113103
{ label: "Create Emission Proposal", slug: "how-to-guides/goal-leaders/create-emission-proposal" },
104+
{ label: "Create Capability Permission", slug: "how-to-guides/goal-leaders/create-capability-permission" },
105+
{ label: "Create Emission Permission", slug: "how-to-guides/goal-leaders/create-emission-permission" },
106+
{ label: "Manage Permissions", slug: "how-to-guides/goal-leaders/manage-permissions" },
114107
],
115108
},
116109
],

‎src/content/docs/development/network/global-parameters.mdx‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,39 @@ Global Parameter changes require a proposal to pass through the [DAO governance
1111

1212
### Network & Registration Parameters
1313

14-
- **`max_allowed_agents`**: The maximum number of agents allowed in the network (default: 10.000). Sets an upper limit on the total number of agents that can be registered.
15-
1614
- **`max_registrations_per_block`**: The maximum number of registrations allowed per block (default: 10). Controls how many new registrations can be processed in a single block.
1715

1816
- **`target_registrations_interval`**: The number of blocks that defines the registration interval (default: 142). Defines the target interval for registration calculations.
1917

2018
- **`target_registrations_per_interval`**: The desired number of registrations per interval (default: 3). Sets the target number of registrations within each interval.
2119

22-
- **`max_registrations_per_interval`**: The maximum registrations allowed per interval (default: 32). Upper limit on registrations processed per interval.
20+
- **`max_registrations_per_interval`**: The maximum registrations allowed per interval (default: 16). Upper limit on registrations processed per interval.
2321

2422
### Token Emission Parameters
2523

26-
- **`block_emission`**: The emission per block (~5.93 TORUS). It specifies the amount of new tokens emitted in each block.
24+
- **`block_emission`**: The emission per block (5925.93 TORUS). It specifies the amount of new tokens emitted in each block.
2725

2826
- **`halving_interval`**: Token supply at halving events (default: 144,000,000 TORUS). Defines when emission halving occurs.
2927

3028
- **`max_supply`**: Maximum total token supply (default: 144,000,000 TORUS). Hard cap on total tokens that can exist.
3129

32-
- **`emission_reciclying_percentage`**: Percentage of emission recycled (default: 100%). Controls how much emission is recycled back into the system.
30+
- **`emission_recycling_percentage`**: Percentage of emission recycled (default: 81%). Controls how much emission is recycled back into the system.
3331

3432
- **`incentives_ratio`**: Ratio for incentives distribution (default: 50%). Determines allocation between different incentive mechanisms.
3533

3634
### Agent & Name Parameters
3735

3836
- **`max_name_length`**: The maximum length allowed for an agent name (default: 32 characters). Sets upper limit on agent name length.
3937

40-
- **`min_name_length`**: The minimum length allowed for an agent name (defaul: 2 characters). Sets lower limit on agent name length.
38+
- **`min_name_length`**: The minimum length allowed for an agent name (default: 2 characters). Sets lower limit on agent name length.
4139

4240
- **`max_agent_url_length`**: The maximum URL length for agents (default: 64 characters). Controls agent URL field length.
4341

4442
### Burn & Stake Parameters
4543

46-
- **`min_burn`**: The minimum burn required for registration (default: 10 TORUS). Sets minimum amount of tokens to burn for registration.
44+
- **`min_burn`**: The minimum burn required for registration (default: 15 TORUS). Sets minimum amount of tokens to burn for registration.
4745

48-
- **`max_burn`**: The maximum burn allowed for registration (default: 150 TORUS). Sets upper limit on registration burn amount.
46+
- **`max_burn`**: The maximum burn allowed for registration (default: 1,000 TORUS). Sets upper limit on registration burn amount.
4947

5048
- **`min_allowed_stake`**: The minimum stake allowed (default: 0.5 TORUS). Specifies minimum amount that can be staked on an agent.
5149

@@ -55,7 +53,7 @@ Global Parameter changes require a proposal to pass through the [DAO governance
5553

5654
- **`min_weight_control_fee`**: The minimum weight control fee (default: 4%). Sets minimum fee for weight control operations.
5755

58-
- **`treasure_emission_fee`**: Treasury fee on emissions (default: 20%). Percentage of emissions allocated to the treasury.
56+
- **`treasure_emission_fee`**: Treasury fee on emissions (default: 5%). Percentage of emissions allocated to the treasury.
5957

6058
### Weight & Reward Parameters
6159

@@ -80,10 +78,16 @@ Global Parameter changes require a proposal to pass through the [DAO governance
8078
- **`agent_application_expiration`**: Agent application expiration (default: 216,000 blocks). Duration before agent applications expire.
8179

8280

83-
## Listing parameters through CLI
81+
## Querying Parameters
82+
83+
### Using CLI
8484

8585
You can query all of these global parameters using CLI:
8686

8787
```bash
8888
torus network params
89-
```
89+
```
90+
91+
### Using Polkadot.js Apps
92+
93+
You can also query current parameter values directly using [Polkadot.js Apps](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fapi.torus.network#/chainstate). Simply select the correct pallet (e.g., `emission0`, `torus0`, `governance`) from the dropdown and choose the parameter you want to query to see the current live values.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Agent Editing
2+
title: Agent Managing
33
description: Understanding agent lifecycle, ownership, and the mechanics of agent updates in Torus.
44
---
55

@@ -13,8 +13,8 @@ import {
1313
} from "@astrojs/starlight/components";
1414

1515

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.
16+
Agent managing in Torus allows agents to update their metadata, endpoints, and social connections after initial registration.
17+
Only the original registering wallet maintains management rights, ensuring agent integrity.
1818

1919
Agents can modify display information (titles, descriptions), service endpoints, visual assets, and social media links.
2020
Core identifiers and cryptographic associations remain immutable once set during registration.
@@ -38,5 +38,5 @@ This balances blockchain immutability with the flexibility needed for comprehens
3838
- **[Root Agents](https://docs.torus.network/explanations/goal-leaders/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/builders/edit-your-agent/) for practical instructions.
41+
Follow our [step-by-step guide to manage your agent](https://docs.torus.network/how-to-guides/builders/manage-your-agent/) for practical instructions.
4242
</Aside>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Agent metadata is stored off-chain via IPFS but referenced on-chain through cont
4545
### Related Concepts
4646

4747
- **[Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/)** - Agents that receive emissions directly
48-
- **[Permission System](https://docs.torus.network/explanations/v06/permissions/)** - How agents interact and delegate authority
49-
- **[Governance & DAO](https://docs.torus.network/explanations/v06/governance-dao/)** - Understanding DAO decision-making processes
48+
- **[Permission System](https://docs.torus.network/explanations/goal-leaders/permissions/)** - How agents interact and delegate authority
49+
- **[Governance & DAO](https://docs.torus.network/explanations/goal-leaders/governance-dao/)** - Understanding DAO decision-making processes
5050

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

src/content/docs/explanations/v06/capability-permissions.mdx renamed to src/content/docs/explanations/builders/capability-permissions.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Capability Permissions
33
description: Understanding the capability permission system for agent endpoints
44
---
55

6+
<Aside type="note" title="Version notice">
7+
This version is based on the Torus v0.6 and is expected to change with the Torus v1.
8+
</Aside>
9+
610
import {
711
CardGrid,
812
LinkCard,

src/content/docs/explanations/v06/control-space.mdx renamed to src/content/docs/explanations/builders/control-space.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Control Space
33
description: Understand the Torus Control Space and how namespaces enable the integration of offchain capabilities and resources with Torus onchain permission system.
44
---
55

6+
<Aside type="note" title="Version notice">
7+
This version is based on the Torus v0.5 and is expected to change with the Torus v1.
8+
</Aside>
9+
610
import { CardGrid, LinkCard, Aside } from "@astrojs/starlight/components";
711

812
### Control Space

src/content/docs/explanations/v06/emission-permissions.mdx renamed to src/content/docs/explanations/goal-leaders/emission-permissions.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Emission Permissions
33
description: Complete guide to emission permissions, stream delegation, and economic coordination mechanisms in Torus.
44
---
55

6+
<Aside type="note" title="Version notice">
7+
This version is based on the Torus v0.5 and is expected to change with the Torus v1.
8+
</Aside>
9+
610
import { CardGrid, LinkCard, Aside, Tabs, TabItem } from "@astrojs/starlight/components";
711

812
Emission permissions are the core tool and mechanism for economic incentives on Torus, enabling agents to compose and delegate portions of their incoming emission streams (token flows) to other agents with flexible control. This enables agents to hire other agents and form economic group structures.

‎src/content/docs/explanations/goal-leaders/emission-proposals.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ For a proposal to pass, it must meet two requirements:
4949

5050
## Related Concepts
5151

52-
- **[Governance & DAO](https://docs.torus.network/explanations/v06/governance-dao/)** - Understanding the broader DAO framework
52+
- **[Governance & DAO](https://docs.torus.network/explanations/goal-leaders/governance-dao/)** - Understanding the broader DAO framework
5353
- **[Tokenomics](https://docs.torus.network/explanations/holders/tokenomics/)** - How TORUS token economics work
54-
- **[Permission System](https://docs.torus.network/explanations/v06/permissions/)** - How governance permissions enable proposal creation
54+
- **[Permission System](https://docs.torus.network/explanations/goal-leaders/permissions/)** - How governance permissions enable proposal creation
5555

5656
<Aside type="tip" title="Ready to Create a Proposal?">
5757
Follow our [emission proposal guide](https://docs.torus.network/how-to-guides/goal-leaders/create-emission-proposal/) to learn the step-by-step process.

src/content/docs/explanations/v06/governance-dao.mdx renamed to src/content/docs/explanations/goal-leaders/governance-dao.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: Learn about the governance and operation of the Torus DAO.
55

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

8+
<Aside type="note" title="Version notice">
9+
This version is based on the Torus v0.5 and is expected to change with the Torus v1.
10+
</Aside>
11+
812
The Torus DAO operates fully on-chain and is TORUS stake-based, managing the protocol through proposals.
913

1014
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.

src/content/docs/explanations/v06/permissions.mdx renamed to src/content/docs/explanations/goal-leaders/permissions.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: Comprehensive guide to Torus's recursive delegation system, emissio
55

66
import { CardGrid, LinkCard, Aside, Tabs, TabItem } from "@astrojs/starlight/components";
77

8+
<Aside type="note" title="Version notice">
9+
This version is based on the Torus v0.5 and is expected to change with the Torus v1.
10+
</Aside>
11+
812
The Torus v0.5 implements a flexible **recursive delegation system** called Permission0 that enables fine-grained control over emission distribution, agent capability access, and governance functions.
913

1014
## Permission Architecture Overview

0 commit comments

Comments
 (0)