Skip to content

Commit cb495a2

Browse files
authored
New hover functionality (#27)
* Add "Manage Permissions" link in the start-here guide to improve user navigation for managing capabilities in Torus * refactor: update "Start Here" to "Table of Contents" across documentation for improved organization and clarity * feat: enhance documentation with collapsible sections and a new "Staking" guide for improved user experience and information access * fix: reformat links in documentation for token holders, agent builders, and swarm leaders for better readability and access * refactor: remove deprecated "Delegate Emission Streams" guide and tidy up table of contents for better documentation structure * feat: update documentation structure and add tooltip styles for enhanced user accessibility and understanding of TORUS concepts * fix: improve readability of 'fractalSuperSwarm' definition by refining sentence structure in concepts terminology documentation * refactor: enhance documentation clarity and styling, focusing on swarms explanation and content link customization guide
1 parent ef09aa0 commit cb495a2

File tree

11 files changed

+341
-98
lines changed

11 files changed

+341
-98
lines changed

astro.config.mjs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ export default defineConfig({
2626
label: "Getting Started",
2727
items: [
2828
{ label: "Welcome", slug: "index" },
29-
{ label: "Tokenomics", slug: "getting-started/tokenomics" },
30-
{ label: "Concepts & Terminology", slug: "getting-started/concepts-terminology" },
31-
{ label: "Understanding Torus", slug: "getting-started/concepts" },
29+
{ label: "Understanding Torus", slug: "getting-started/understanding-torus" },
3230
],
3331
},
3432
{
@@ -53,6 +51,8 @@ export default defineConfig({
5351
label: "Holders",
5452
collapsed: true,
5553
items: [
54+
55+
{ label: "Tokenomics", slug: "explanations/holders/tokenomics" },
5656
{ label: "Staking", slug: "explanations/holders/staking" },
5757
],
5858
},
@@ -75,6 +75,7 @@ export default defineConfig({
7575
{ label: "Emission Proposals", slug: "explanations/goal-leaders/emission-proposals" },
7676
],
7777
},
78+
{ label: "Concepts & Terminology", slug: "explanations/concepts-terminology" },
7879
],
7980
},
8081
{
@@ -151,6 +152,9 @@ export default defineConfig({
151152
],
152153
},
153154
],
155+
components: {
156+
Head: './src/components/Head.astro',
157+
},
154158
customCss: ["./src/tailwind.css"],
155159
}),
156160
tailwind({ applyBaseStyles: false }),

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"@astrojs/starlight-tailwind": "^3.0.0",
1616
"@astrojs/tailwind": "^6.0.0",
1717
"astro": "^5.3.0",
18+
"astro-tooltips": "^0.6.2",
1819
"tailwindcss": "^3.4.4",
1920
"typescript": "^5.7.2"
2021
},

pnpm-lock.yaml

Lines changed: 22 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/components/Head.astro

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
import type { Props } from '@astrojs/starlight/props';
3+
import StarlightHead from '@astrojs/starlight/components/Head.astro';
4+
import { Tooltips } from 'astro-tooltips';
5+
---
6+
7+
<StarlightHead {...Astro.props}><slot /></StarlightHead>
8+
<Tooltips interactive={false} delay={[150, 100]} placement="top" />
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
---
2+
title: Concepts & Terminology
3+
description: Key terms and concepts used throughout the Torus ecosystem
4+
---
5+
6+
import { Aside } from "@astrojs/starlight/components";
7+
8+
export const DEFINITIONS = {
9+
// Core Concepts
10+
agent: `An autonomous entity in Torus that can perform actions, provide services,
11+
and participate in swarms. Agents can be registered users, automated services, or any entity
12+
capable of interacting with the protocol.`,
13+
14+
swarm: `A coordinated group of agents working together toward a common goal. Swarms form
15+
organically around specific objectives and can operate at multiple scales within the network.`,
16+
17+
hypergraph: `The emergent network structure formed by all agents, their relationships, permissions,
18+
and interactions. The hypergraph represents the complete state of coordination within Torus.`,
19+
20+
rootAgent: `A special type of agent with elevated permissions to receive emissions directly from
21+
the protocol and set goals for swarm formation. Root agents lead major initiatives and coordinate
22+
large-scale activities.`,
23+
24+
// Permissions & Capabilities
25+
capability: `A specific function or service that an agent can provide to others. Capabilities are
26+
registered on-chain and define what an agent can do within the network.`,
27+
28+
permission: `The right to use or delegate a specific capability. Permissions can be granted, revoked,
29+
and delegated between agents to enable complex coordination patterns.`,
30+
31+
delegation: `The process of granting permission to use a capability to another agent. Delegation
32+
enables specialization and collaborative work within swarms.`,
33+
34+
controlSpace: `The coordination layer where agents register capabilities, manage permissions, and
35+
coordinate activities. It serves as the control plane for the entire network.`,
36+
37+
// Economic Terms
38+
torusToken: `The native token of Torus used for staking, governance, and accessing
39+
network services.`,
40+
41+
staking: `The process of locking TORUS tokens to participate in network security and earn rewards.
42+
Staked tokens can be allocated to support specific agents.`,
43+
44+
emissions: `Token rewards distributed to agents and stakeholders based on their contributions to
45+
the network. Emissions flow from root agents to the broader ecosystem.`,
46+
47+
allocation: `The distribution of staked tokens to support specific agents or initiatives. Allocations
48+
determine how emissions flow through the network.`,
49+
50+
// Technical Terms
51+
agentServer: `A service that hosts agent capabilities and provides APIs for other agents to interact
52+
with. Agent servers make capabilities discoverable and usable across the network.`,
53+
54+
agentClient: `A component that allows agents to discover and interact with capabilities provided by
55+
other agents. Clients handle authentication and communication protocols.`,
56+
57+
signal: `A message broadcast by an agent expressing demand for specific capabilities or announcing
58+
the availability of services. Signals help coordinate supply and demand within swarms.`,
59+
60+
substrate: `The blockchain framework that powers Torus. Substrate provides the runtime
61+
environment for the protocol's core functionality.`,
62+
63+
// Governance Terms
64+
dao: `The governance structure through which major protocol decisions are made. Torus DAO
65+
enables stakeholder participation in network evolution.`,
66+
67+
proposal: `A formal suggestion for protocol changes, new features, or resource allocation submitted
68+
to the DAO for consideration and voting.`,
69+
70+
governanceToken: `TORUS tokens used for voting on proposals and participating in decentralized
71+
governance processes.`,
72+
73+
// ================= Compound Terms =================
74+
// Agent & Swarm together
75+
agentSwarm: `A coordinated group of autonomous entities working together in Torus toward
76+
a common goal, forming organically around specific objectives and operating at multiple scales.`,
77+
78+
// Protocol & Architecture Terms
79+
stakeBasedP2PProtocol: `A peer-to-peer network where participation and influence are determined by the amount of tokens locked (staked) in the system, ensuring aligned incentives among participants.`,
80+
81+
fractalSuperSwarm: `A hierarchical structure where the entire system mirrors its own patterns at every scale. Smaller swarms within swarms, all following the same organizational principles.`,
82+
83+
recursivelyDelegated: `A cascading permission system where agents can grant others the ability to further delegate their permissions, creating chains of trust and capability sharing.`,
84+
85+
subgraph: `A smaller, self-contained network within the larger hypergraph that represents individual swarms and their internal relationships.`,
86+
87+
stakeRoot: `The central origin point of the network's authority, derived from the collective stake of all token holders, serving as the ultimate source of permissions and incentives.`,
88+
89+
// Coordination Terms
90+
topDownGoals: `Objectives set by root agents or high-level stakeholders that cascade through the network, providing direction while allowing bottom-up implementation.`,
91+
92+
selfAssemblingMultiScaleCompetencyArchitecture: `Autonomous structures that spontaneously organize at different levels of complexity, with each level capable of solving problems appropriate to its scale.`,
93+
94+
openCompetitionAtEveryEdge: `A system where any connection between agents can be challenged or improved by alternative solutions, ensuring continuous optimization.`,
95+
96+
recursiveNicheConstruction: `The iterative process where swarms create specialized roles and environments that enable further specialization, building increasingly sophisticated capabilities.`,
97+
98+
granularSpecialization: `The ability for agents to develop deep expertise in very specific areas while maintaining connections to the broader network through the permission system.`,
99+
100+
// Implementation Terms
101+
pragmaticGrowthOriented: `Designed for real-world deployment with features that prioritize network expansion and adoption over theoretical completeness.`,
102+
103+
battletesting: `Live deployment to stress-test concepts under real conditions with actual users and economic incentives.`,
104+
105+
pureAndCompleteImplementation: `The final version that fully realizes all theoretical aspects of the Torus model without compromises made for initial deployment.`,
106+
107+
108+
// General Technical Terms
109+
recursive: `Recursive describes a process or definition that refers back to itself.
110+
It works by applying the same rule to a simpler version of the original.
111+
Each step breaks the problem into a smaller piece and repeats the same approach until it reaches that simplest instance.`
112+
113+
};
114+
115+
This glossary defines the key terms and concepts used throughout Torus documentation.
116+
Understanding these terms will help you navigate the ecosystem more effectively.
117+
118+
## Core Concepts
119+
120+
### Agent
121+
&nbsp;{DEFINITIONS.agent}
122+
123+
### Swarm
124+
&nbsp;{DEFINITIONS.swarm}
125+
126+
### Hypergraph
127+
&nbsp;{DEFINITIONS.hypergraph}
128+
129+
### Root Agent
130+
&nbsp;{DEFINITIONS.rootAgent}
131+
132+
### Recursive
133+
&nbsp;{DEFINITIONS.recursive}
134+
135+
## Permissions & Capabilities
136+
137+
### Capability
138+
&nbsp;{DEFINITIONS.capability}
139+
140+
### Permission
141+
&nbsp;{DEFINITIONS.permission}
142+
143+
### Delegation
144+
&nbsp;{DEFINITIONS.delegation}
145+
146+
### Control Space
147+
&nbsp;{DEFINITIONS.controlSpace}
148+
149+
## Economic Terms
150+
151+
### TORUS Token
152+
&nbsp;{DEFINITIONS.torusToken}
153+
154+
### Staking
155+
&nbsp;{DEFINITIONS.staking}
156+
157+
### Emissions
158+
&nbsp;{DEFINITIONS.emissions}
159+
160+
### Allocation
161+
&nbsp;{DEFINITIONS.allocation}
162+
163+
## Technical Terms
164+
165+
### Agent Server
166+
&nbsp;{DEFINITIONS.agentServer}
167+
168+
### Agent Client
169+
&nbsp;{DEFINITIONS.agentClient}
170+
171+
### Signal
172+
&nbsp;{DEFINITIONS.signal}
173+
174+
### Substrate
175+
&nbsp;{DEFINITIONS.substrate}
176+
177+
## Governance Terms
178+
179+
### DAO (Decentralized Autonomous Organization)
180+
&nbsp;{DEFINITIONS.dao}
181+
182+
### Proposal
183+
&nbsp;{DEFINITIONS.proposal}
184+
185+
### Governance Token
186+
&nbsp;{DEFINITIONS.governanceToken}
187+
188+
<Aside>
189+
**New terms being added regularly.** As Torus ecosystem evolves, new concepts and terminology emerge.
190+
Check back here for updates or suggest additions through our community channels.
191+
</Aside>
File renamed without changes.

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,12 @@ Understanding the technical implementation and design of Torus v0.5:
3131

3232
## For Holders
3333

34-
Understanding how holders participate in the network:
3534

36-
- [Staking](https://docs.torus.network/explanations/holders/staking/) — Staking mechanisms, incentives, and reward distribution
35+
Learn about TORUS economics and understand how you can participate:
36+
37+
- [Tokenomics](https://docs.torus.network/explanations/holders/tokenomics/) — Economics of TORUS: supply mechanisms and emission distribution models
38+
- [Staking](https://docs.torus.network/explanations/holders/staking/) — Staking mechanisms and incentives for network participation
39+
3740

3841
---
3942

0 commit comments

Comments
 (0)