Skip to content

Commit 9b5ead5

Browse files
Sipherrad2520
andauthored
Reorganize documentation with System section first and improve navigation structure (#36)
* Refactor table of contents to group system-related guides under a new "System" section for better organization and clarity * Remove redundant notes from the table of contents to streamline guidance on proposal and permission creation processes * Update index.mdx * Refactor explanations and guides by updating capability and control space documentation for clarity and improved navigation * Enhance system documentation by adding and reorganizing sections on permissions and capabilities in explanations and guides --------- Co-authored-by: rad2520 <[email protected]>
1 parent ce28b68 commit 9b5ead5

17 files changed

+73
-50
lines changed

astro.config.mjs

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ export default defineConfig({
3333
label: "Explanations",
3434
items: [
3535
{ label: "Table of Contents", slug: "explanations/table-of-contents" },
36+
{
37+
label: "System",
38+
collapsed: true,
39+
items: [
40+
{ label: "Control Space", slug: "explanations/system/control-space" },
41+
{ label: "Permission System", slug: "explanations/system/permission-system" },
42+
{ label: "Recursive Delegation", slug: "explanations/system/recursive-delegation" },
43+
{ label: "Emission Permissions", slug: "explanations/system/emission-permissions" },
44+
{ label: "Capability Permissions", slug: "explanations/system/capability-permissions" },
45+
],
46+
},
3647
{
3748
label: "Holders",
3849
collapsed: true,
@@ -51,8 +62,6 @@ export default defineConfig({
5162
{ label: "Demand Signaling", slug: "explanations/builders/demand-signaling" },
5263
{ label: "Agent Server", slug: "explanations/builders/agent-server" },
5364
{ 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" },
5665
],
5766
},
5867
{
@@ -62,9 +71,6 @@ export default defineConfig({
6271
{ label: "Root Agents", slug: "explanations/goal-leaders/root-agents" },
6372
{ label: "DAO Treasury", slug: "explanations/goal-leaders/dao-treasury" },
6473
{ label: "Emission Proposals", slug: "explanations/goal-leaders/emission-proposals" },
65-
{ label: "Permission System", slug: "explanations/goal-leaders/permissions" },
66-
{ label: "Recursive Delegation", slug: "explanations/goal-leaders/recursive-delegation" },
67-
{ label: "Emission Permissions", slug: "explanations/goal-leaders/emission-permissions" },
6874
{ label: "Governance & DAO", slug: "explanations/goal-leaders/governance-dao" },
6975
],
7076
},
@@ -75,6 +81,16 @@ export default defineConfig({
7581
label: "How-to Guides",
7682
items: [
7783
{ label: "Table of Contents", slug: "how-to-guides/table-of-contents" },
84+
{
85+
label: "System",
86+
collapsed: true,
87+
items: [
88+
{ label: "Create Permission", slug: "how-to-guides/system/create-permission" },
89+
{ label: "Create Capability Permission", slug: "how-to-guides/system/create-capability-permission" },
90+
{ label: "Create Emission Permission", slug: "how-to-guides/system/create-emission-permission" },
91+
{ label: "Manage Permissions", slug: "how-to-guides/system/manage-permissions" },
92+
],
93+
},
7894
{
7995
label: "Holders",
8096
collapsed: true,
@@ -104,9 +120,6 @@ export default defineConfig({
104120
{ label: "Become a Root Agent", slug: "how-to-guides/goal-leaders/become-a-root-agent" },
105121
{ label: "Request DAO Treasury Transfer", slug: "how-to-guides/goal-leaders/request-dao-treasury-transfer" },
106122
{ label: "Create Emission Proposal", slug: "how-to-guides/goal-leaders/create-emission-proposal" },
107-
{ label: "Create Capability Permission", slug: "how-to-guides/goal-leaders/create-capability-permission" },
108-
{ label: "Create Emission Permission", slug: "how-to-guides/goal-leaders/create-emission-permission" },
109-
{ label: "Manage Permissions", slug: "how-to-guides/goal-leaders/manage-permissions" },
110123
],
111124
},
112125
],

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ 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/goal-leaders/permissions/)** - How agents interact and delegate authority
48+
- **[Permission System](https://docs.torus.network/explanations/system/permission-system/)** - How agents interact and delegate authority
4949
- **[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?">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For a proposal to pass, it must meet two requirements:
5151

5252
- **[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/goal-leaders/permissions/)** - How governance permissions enable proposal creation
54+
- **[Permission System](https://docs.torus.network/explanations/system/permission-system/)** - 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/builders/capability-permissions.mdx renamed to src/content/docs/explanations/system/capability-permissions.mdx

File renamed without changes.

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

File renamed without changes.

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

File renamed without changes.

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

File renamed without changes.

src/content/docs/explanations/goal-leaders/recursive-delegation.mdx renamed to src/content/docs/explanations/system/recursive-delegation.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,10 @@ The root owner of a capability path can delegate any amount of permission instan
4747

4848
### Related Concepts
4949

50-
- **[Permission System](https://docs.torus.network/explanations/goal-leaders/permissions/)** - Core permission mechanics and delegation basics
51-
- **[Permission System](https://docs.torus.network/explanations/goal-leaders/permissions/)** - Permission system architecture and delegation basics
50+
- **[Permission System](https://docs.torus.network/explanations/system/permission-system/)** - Core permission mechanics and delegation basics
5251
- **[Agent Registration](https://docs.torus.network/explanations/builders/agent-registration/)** - How agents become capable of receiving delegations
5352
- **[Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/)** - Agents with direct emission access for delegation
5453

5554
<Aside type="tip" title="Ready to Create Recursive Delegation?">
56-
Follow our [step-by-step guide to create capability permissions](https://docs.torus.network/how-to-guides/goal-leaders/create-capability-permission/) for practical implementation instructions.
55+
Follow our [step-by-step guide to create capability permissions](https://docs.torus.network/how-to-guides/system/create-capability-permission/) for practical implementation instructions.
5756
</Aside>

src/content/docs/explanations/table-of-contents.mdx

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ If you need to accomplish a specific task, check out our [How-to Guides](https:/
1818
These explanations provide deep understanding of how Torus works, the concepts, mechanisms of Torus.
1919

2020

21+
## System Architecture
22+
23+
Core system components and mechanisms:
24+
25+
- [Control Space](https://docs.torus.network/explanations/system/control-space/) — Foundational permission and capability framework
26+
- [Permission System](https://docs.torus.network/explanations/system/permission-system/) — How agents interact and delegate authority
27+
- [Recursive Delegation](https://docs.torus.network/explanations/system/recursive-delegation/) — Specific capability delegation mechanisms
28+
- [Emission Permissions](https://docs.torus.network/explanations/system/emission-permissions/) — How emissions are allocated and controlled
29+
- [Capability Permissions](https://docs.torus.network/explanations/system/capability-permissions/) — Fine-grained access control for agent endpoints
30+
31+
---
32+
2133
## For Holders
2234

2335

@@ -38,8 +50,6 @@ Understanding how agent systems work within Torus:
3850
- [Demand Signaling](https://docs.torus.network/explanations/builders/demand-signaling/) — Capability coordination and economic incentives
3951
- [Agent Server](https://docs.torus.network/explanations/builders/agent-server/) — API architecture, authentication, and capability sharing
4052
- [Agent Client](https://docs.torus.network/explanations/builders/agent-client/) — Communication patterns and authentication flow
41-
- [Control Space](https://docs.torus.network/explanations/builders/control-space/) — Foundational permission and capability framework
42-
- [Capability Permissions](https://docs.torus.network/explanations/builders/capability-permissions/) — Fine-grained access control for agent endpoints
4353

4454
---
4555

@@ -50,9 +60,6 @@ Understanding governance and leadership systems:
5060
- [Root Agents](https://docs.torus.network/explanations/goal-leaders/root-agents/) — DAO approval process and direct emission access
5161
- [DAO Treasury](https://docs.torus.network/explanations/goal-leaders/dao-treasury/) — Community funding mechanisms and proposal processes
5262
- [Emission Proposals](https://docs.torus.network/explanations/goal-leaders/emission-proposals/) — How to adjust network economics through governance
53-
- [Permission System](https://docs.torus.network/explanations/goal-leaders/permissions/) — How agents interact and delegate authority
54-
- [Recursive Delegation](https://docs.torus.network/explanations/goal-leaders/recursive-delegation/) — Specific capability delegation mechanisms
55-
- [Emission Permissions](https://docs.torus.network/explanations/goal-leaders/emission-permissions/) — How emissions are allocated and controlled
5663
- [Governance & DAO](https://docs.torus.network/explanations/goal-leaders/governance-dao/) — Decision-making processes and community coordination
5764

5865
---

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ By removing outdated or unused capabilities, you reduce the attack surface and k
161161

162162
Now that you can manage capabilities, you might want to:
163163

164-
- **Set up delegation**: [Manage permissions](https://docs.torus.network/how-to-guides/goal-leaders/manage-permissions/) to allow other agents to use your capabilities
164+
- **Set up delegation**: [Manage permissions](https://docs.torus.network/how-to-guides/system/manage-permissions/) to allow other agents to use your capabilities
165165
- **Build agent services**: Create an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide APIs that utilize your registered capabilities
166166
- **Create demand signals**: Signal for [specific capabilities](https://docs.torus.network/how-to-guides/builders/create-signal/) you need from other agents
167167

@@ -171,5 +171,5 @@ Connect with the community:
171171
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
172172

173173
<Aside type="tip" title="Want to Learn More?">
174-
Learn about [recursive delegation](https://docs.torus.network/explanations/goal-leaders/recursive-delegation/) delegation mechanisms and control space architecture.
174+
Learn about [recursive delegation](https://docs.torus.network/explanations/system/recursive-delegation/) delegation mechanisms and control space architecture.
175175
</Aside>

0 commit comments

Comments
 (0)