Skip to content
Merged

Dev #10

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ pnpm-debug.log*

# macOS-specific files
.DS_Store

.env.local
37 changes: 11 additions & 26 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default defineConfig({
{
label: "v0.5",
items: [
// { label: "Network Overview", slug: "concepts/network-overview" },
// { label: "Network Overview", slug: "concepts/network-overview" },
{ label: "Control Space", slug: "v05/control-space" },
{ label: "Permission System", slug: "v05/permissions" },
{ label: "Capability Permissions", slug: "v05/capability-permissions" },
Expand All @@ -51,7 +51,7 @@ export default defineConfig({
items: [
{ label: "Register an Agent", slug: "agents/register-agent" },
{ label: "Become a Root Agent", slug: "agents/apply-root-agent" },
{ label: "Agent Server Setup", slug: "agents/server-setup" },
{ label: "Agent Server", slug: "agents/server-setup" },
{ label: "Agent Client", slug: "agents/client" },
{ label: "Demand Signaling", slug: "agents/demand-signaling" },
{ label: "Managing Your Agent", slug: "agents/management" },
Expand All @@ -64,20 +64,15 @@ export default defineConfig({
{ label: "Balance Operations", slug: "cli/balance-operations" },
],
},
// {
// label: "Web Apps",
// items: [
// {
// label: "Overview",
// slug: "development/web-apps-overview",
// },
// { label: "Torus Portal", slug: "web-apps/torus-portal" },
// { label: "Torus Allocator", slug: "web-apps/torus-allocator" },
// { label: "Torus Wallet", slug: "web-apps/torus-wallet" },
// { label: "Torus Bridge", slug: "web-apps/torus-bridge" },
// { label: "Torus DAO", slug: "web-apps/torus-dao" },
// ],
// },
{
label: "Web Apps",
items: [
{ label: "Torus Portal", slug: "web-apps/torus-portal" },
{ label: "Torus Allocator", slug: "web-apps/torus-allocator" },
{ label: "Torus Wallet", slug: "web-apps/torus-wallet" },
{ label: "Torus DAO", slug: "web-apps/torus-dao" },
],
},
{
label: "Development",
items: [
Expand All @@ -102,18 +97,8 @@ export default defineConfig({
],
},
],
editLink: {
baseUrl: "https://github.com/renlabs-dev/torus-docs/edit/main/docs/",
},
customCss: ["./src/tailwind.css"],
}),
tailwind({ applyBaseStyles: false }),
],

vite: {
server: {
host: true,
allowedHosts: true,
},
},
});
4 changes: 2 additions & 2 deletions src/content/docs/agents/register-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ prev:
link: /concepts/governance-dao
label: Governance & DAO
next:
link: /agents/apply-root-agent
label: Become a Root Agent
link: /agents/client
label: Interacting with Agents
---

import {
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/concepts/network-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ Weights provide an expressive format for granularly representing the relative va

<CardGrid>
<LinkCard
title="Agent basics"
href="/agents/what-is-a-agent"
title="Concepts"
href="/getting-started/concepts"
description="Learn about the basic concepts of agents."
/>
<LinkCard
title="DAO Basics"
href="/concepts/torus-dao"
title="Governance & DAO"
href="/concepts/governance-dao"
description="Learn the DAO model basics in Torus."
/>
</CardGrid>
20 changes: 15 additions & 5 deletions src/content/docs/getting-started/setup-wallet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,22 @@ For further assistance, you can access detailed tutorials and user guides on the

By following these steps, you can effectively set up and start using your SubWallet to manage, receive, and send assets across multiple blockchain networks, ensuring a secure and efficient digital asset management experience.

## CLI
#### Related Topics

<CardGrid>
<LinkCard href="/cli/key-management" title="Key Operations in CLI" />
<LinkCard
href="/cli/balance-operations"
title=" Balance Operations in CLI"
<LinkCard
title="Key Operations in CLI"
href="/cli/key-management"
description="Learn how to manage your keys in CLI"
/>
<LinkCard
title="Balance Operations in CLI"
href="/cli/balance-operations"
description="Learn how to manage your balance in CLI"
/>
<LinkCard
title="Torus Wallet"
href="/web-apps/torus-wallet"
description="Learn how to manage your wallet in the web app"
/>
</CardGrid>
4 changes: 2 additions & 2 deletions src/content/docs/v05/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ The enforcement system creates a sophisticated bridge between on-chain permissio
<CardGrid>
<LinkCard
title="Control Space"
href="/advanced/control-space"
href="/v05/control-space"
description="Understand how control space enables capability instantiation."
/>
<LinkCard
title="Capability Permissions"
href="/advanced/capability-permissions"
href="/v05/capability-permissions"
description="Learn how agents use capability permissions for access controls."
/>
<LinkCard
Expand Down
72 changes: 50 additions & 22 deletions src/content/docs/web-apps/torus-allocator.mdx
Original file line number Diff line number Diff line change
@@ -1,46 +1,74 @@
---
title: How to Use Torus Allocator
description: Complete guide to discovering agents, allocating stake, and managing delegations.
description: Guide to discovering root agents and allocating your stake weight.
---

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

Learn how to use Torus Allocator to discover agents, allocate your stake, and manage your delegation strategy for optimal returns.
Torus Allocator lets you allocate your stake weight to root agents. Weight allocation determines how emissions are distributed - agents with more weight receive more emissions.

## Overview
## Prerequisites

Torus Allocator is the primary interface for discovering and evaluating agents, allowing you to make informed decisions about stake allocation and support the agents you believe in.
**Stake Requirement**: You must have TORUS staked on the "Torus Allocator" allocator before you can allocate weights.

**Key Features:**
- Browse and discover agents
- Allocate stake to promising agents
- Manage delegation strategy
For staking details, see [torus wallet](torus-wallet).

## Getting Started
## Interface Overview

[Content to be added - accessing Torus Allocator and initial setup]
**Main View**: Browse all root agents showing:
- Agent name and social links
- TORUS emissions received from stake root
- Short description

## Discovering Agents
**Weight Allocation**: Use sliders to distribute your weight (0-100%) across multiple root agents.

[Content to be added - how to browse, search, and filter agents]
**Allocation Menu**: Review and submit your weight distribution.

## Stake Allocation
## Agent Details

[Content to be added - how to allocate and manage stake across agents]
**Expanded View**: Click any root agent to see detailed information:
- Agent address and API endpoint
- USD value of emissions received
- Full agent description
- "Report Agent to DAO" option

**Agent Management**: If you're a root agent owner, you can edit your agent information directly in the expanded view.

## Allocating Weights

1. **Connect**: Visit [allocator.torus.network](https://allocator.torus.network) and connect wallet
2. **Browse Agents**: Review available root agents and their metrics
3. **Set Weights**: Use sliders to allocate percentages to chosen agents
4. **Open Allocation Menu**: Review your weight distribution
5. **Submit**: Confirm allocations and sign transaction

<Aside type="note">
Total weight allocation must equal 100% or 0%. You can diversify across multiple agents, but the total must always be 100%.
</Aside>

## Managing Allocations

[Content to be added - how to rebalance and optimize your stake allocations]
**Removing Allocations**:
1. Open "Allocation Menu"
2. Click "Remove Agents"
3. Sign the transaction

**Updating Allocations**:
- Adjust sliders for new distribution
- Submit changes through Allocation Menu
- Previous allocations are automatically replaced

#### Related Topics

<CardGrid>
<LinkCard
title="Stake & Weights"
href="/concepts/stake-weights"
description="Understand how staking and weights work in the network."
title="Torus Portal"
href="/web-apps/torus-portal"
description="Manage permissions and capabilities"
/>
<LinkCard
title="Agents"
href="/concepts/agents"
description="Learn about agents and how they create value."
title="Torus Wallet"
href="/web-apps/torus-wallet"
description="Manage your stake and allocations"
/>
</CardGrid>
44 changes: 0 additions & 44 deletions src/content/docs/web-apps/torus-bridge.mdx

This file was deleted.

78 changes: 57 additions & 21 deletions src/content/docs/web-apps/torus-dao.mdx
Original file line number Diff line number Diff line change
@@ -1,44 +1,80 @@
---
title: How to Use Torus DAO
description: Complete guide to participating in Torus DAO governance and voting.
description: Guide to participating in governance, voting on proposals, and managing whitelist applications.
---

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

Learn how to participate in Torus DAO governance, vote on proposals, and shape the future of the network.
[Torus DAO](https://dao.torus.network/) is the governance interface for participating in network decisions, voting on proposals, and managing agent whitelisting.

## Overview
## Interface Overview

The Torus DAO is the decentralized governance system that allows community members to participate in network decisions, vote on proposals, and manage the treasury.
The DAO page has three main sections:

**Key Features:**
- Vote on governance proposals
- Submit new proposals
- Manage treasury funds
- Participate in network parameter changes
- Review and approve whitelist applications
**Proposals**: View and vote on governance proposals, create new proposals

## Getting Started
**DAO Dashboard**: Network metrics, agent health monitoring, DAO member applications

[Content to be added - detailed explanation of Torus DAO]
**Whitelist Applications**: Review agent whitelist applications, submit new applications

## Creating Proposals
## [Whitelist Applications](https://dao.torus.network/whitelist-applications)

[Content to be added - how to submit governance proposals]
**Viewing Applications**: Browse all whitelist applications (approved, rejected, expired) with search functionality

## Whitelist Applications
**Creating Applications**:
1. Click "Shape the Network" button
2. Select "Whitelist an Agent" from dropdown
3. Fill application form
4. Submit application

[Content to be added - how to review and make a whitelist application]
<Aside type="note">
A valid Discord account is required to apply for whitelist.
</Aside>

## Treasury
## [DAO Dashboard](https://dao.torus.network/dao-dashboard)

[Content to be added - how treasury proposals work]
The dashboard contains three tabs:

**Dashboard Tab**: Network overview including:
- Total registered agents
- Number of whitelisted agents
- Applied penalties count
- DAO applications count
- Agent health statistics

**Agent Health Tab**:
- List all agents with health status
- Search for specific agents
- Filter by health status
- View penalty percentages (penalized agents receive reduced emissions)

**DAO Applications Tab**:
- View applicants for DAO membership
- DAO members can vote on whitelist applications and penalties

## [Proposals](https://dao.torus.network/proposals)

**Viewing Proposals**: Browse all created governance proposals

**Creating Proposals**:
1. Click "Shape the Network" button
2. Select "Create a Proposal" from dropdown
3. Fill proposal form with details
4. Submit for community voting

**Voting**: DAO members can vote to approve/reject proposals and manage network parameters

#### Related Topics

<CardGrid>
<LinkCard
title="Governance & DAO Concepts"
title="Governance & DAO"
href="/concepts/governance-dao"
description="Understand the governance structure and DAO mechanics."
description="Understand governance structure and voting mechanics"
/>
<LinkCard
title="Register a Root Agent"
href="/agents/apply-root-agent"
description="Learn about the root agent application process"
/>
</CardGrid>
Loading