Skip to content
Merged

Dev #11

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
27 changes: 20 additions & 7 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,16 @@ export default defineConfig({
{
label: "v0.5",
items: [
// { 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" },
{ label: "Emission Permissions", slug: "v05/emission-permissions" },
{ label: "Tokenomics", slug: "concepts/tokenomics" },
{ label: "Governance & DAO", slug: "concepts/governance-dao" },
// { 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",
},
{ label: "Emission Permissions", slug: "v05/emission-permissions" },
{ label: "Tokenomics", slug: "concepts/tokenomics" },
{ label: "Governance & DAO", slug: "concepts/governance-dao" },
],
},
{
Expand Down Expand Up @@ -96,6 +99,16 @@ export default defineConfig({
},
],
},
{
label: "How-to Guides",
items: [
{ label: "Setup a wallet", slug: "how-to-guides/setup-a-wallet" },
// {
// label: "Setup a wallet",
// slug: "how-to-guides/setup-a-wallet",
// },
],
},
],
customCss: ["./src/tailwind.css"],
}),
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions src/content/docs/agents/client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ The AgentClient simplifies communication with Agent APIs by:
## Installation

```sh
npm install @torus-network/torus-ts-sdk
npm install @@torus-network/sdk
```

## Basic Usage

```ts
import { AgentClient, Keypair } from "@torus-network/torus-ts-sdk";
import { AgentClient, Keypair } from "@@torus-network/sdk";

// Create a keypair from your mnemonic
const keypair = new Keypair(
Expand Down Expand Up @@ -75,7 +75,7 @@ interface AgentClientOptions {
The `Keypair` class handles SR25519 key generation and JWT token creation:

```ts
import { Keypair } from "@torus-network/torus-ts-sdk";
import { Keypair } from "@@torus-network/sdk";

// Create from mnemonic
const keypair = new Keypair(
Expand Down Expand Up @@ -301,7 +301,7 @@ if (response.success) {
### Memory Agent Client

```ts
import { AgentClient, Keypair } from "@torus-network/torus-ts-sdk";
import { AgentClient, Keypair } from "@@torus-network/sdk";

class MemoryAgentClient {
private client: AgentClient;
Expand Down Expand Up @@ -414,7 +414,7 @@ if (searchResult.success) {
### Environment-based Configuration

```ts
import { AgentClient, Keypair } from "@torus-network/torus-ts-sdk";
import { AgentClient, Keypair } from "@@torus-network/sdk";

// Environment configuration
const config = {
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/agents/server-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ The AgentServer uses **Hono** for HTTP routing and **Zod** for input validation,
## Installation

```sh
npm install @torus-network/torus-ts-sdk
npm install @@torus-network/sdk

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify the package name with double @@ prefix.

The package name @@torus-network/sdk uses an unusual double @@ prefix, which is not standard for npm packages. Standard scoped packages use a single @ prefix (e.g., @torus-network/sdk). This could cause installation failures.

Please verify if this is the correct package name or if it should be @torus-network/sdk instead.

Also applies to: 37-37, 446-446


🏁 Script executed:

#!/bin/bash
# Check if the package exists on npm registry
npm view @@torus-network/sdk --json 2>/dev/null || echo "Package not found with @@"
npm view @torus-network/sdk --json 2>/dev/null || echo "Package not found with single @"

Length of output: 4723


Correct npm package name prefix

The npm package @@torus-network/sdk is invalid (npm scoped packages use a single @). The correct package name on the registry is @torus-network/sdk. Please update all occurrences:

• src/content/docs/agents/server-setup.mdx: lines 31, 37, 446

Replace:

- npm install @@torus-network/sdk
+ npm install @torus-network/sdk
🤖 Prompt for AI Agents
In src/content/docs/agents/server-setup.mdx at lines 31, 37, and 446, the npm
package name is incorrectly written as @@torus-network/sdk with a double '@'.
Replace all occurrences with the correct scoped package name @torus-network/sdk
using a single '@' to fix the invalid package reference.

```

## Basic Usage

```ts
import { AgentServer } from "@torus-network/torus-ts-sdk";
import { AgentServer } from "@@torus-network/sdk";
import { z } from "zod";

const agent = new AgentServer({
Expand Down Expand Up @@ -443,7 +443,7 @@ Visit `http://localhost:3000/docs` to view the interactive API documentation.
Multi method agent is an agent that defines more than 1 method.

```ts
import { AgentServer } from "@torus-network/torus-ts-sdk";
import { AgentServer } from "@@torus-network/sdk";
import { z } from "zod";

const memoryAgent = new AgentServer({
Expand Down
91 changes: 91 additions & 0 deletions src/content/docs/how-to-guides/how-to-guides.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: How to be a builder on Torus
description: A practical guide to getting involved in the Torus Network, from permissions to integration.
---

## Overview

Participating in the Torus Network means becoming an **agent** that contributes value through **signals** and **integrations**. This guide walks you through each step — from setting up your wallet to delivering a fully working agent.

---

## 🧭 Step-by-Step Path

### 1. Set up your wallet

Every agent begins with a wallet that can sign transactions.

👉 [How to create a wallet](/how-to-guides/set-up-wallet)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify that linked guides exist.

Many of the linked how-to guides appear to reference pages that don't exist yet. This could create a poor user experience with broken links.

Also applies to: 26-27, 35-36, 44-45, 53-54, 62-62, 70-71, 84-85


🏁 Script executed:

#!/bin/bash
# Check if the linked guide files exist
guides=(
  "how-to-guides/set-up-wallet"
  "how-to-guides/register-agent"
  "how-to-guides/apply-to-be-whitelisted"
  "how-to-guides/create-permission"
  "how-to-guides/edit-permission"
  "how-to-guides/create-capabilities"
  "how-to-guides/delete-capabilities"
  "how-to-guides/create-signal"
  "how-to-guides/receive-emissions"
  "how-to-guides/agent-api"
  "how-to-guides/host-agent"
  "how-to-guides/connect-to-chain"
  "how-to-guides/respond-to-signal"
)

for guide in "${guides[@]}"; do
  if [ -f "src/content/docs/$guide.mdx" ] || [ -f "src/content/docs/$guide.md" ]; then
    echo "$guide exists"
  else
    echo "$guide not found"
  fi
done

Length of output: 3711


Missing linked how-to guide pages
The following links in src/content/docs/how-to-guides/how-to-guides.mdx point to guides that don’t exist, which will result in broken links:

  • /how-to-guides/set-up-wallet (line 18)
  • /how-to-guides/register-agent (lines 26–27)
  • /how-to-guides/apply-to-be-whitelisted (lines 35–36)
  • /how-to-guides/create-permission (lines 44–45)
  • /how-to-guides/edit-permission (lines 53–54)
  • /how-to-guides/create-capabilities (line 62)
  • /how-to-guides/delete-capabilities (lines 70–71)
  • /how-to-guides/create-signal (lines 84–85)
  • /how-to-guides/receive-emissions
  • /how-to-guides/agent-api
  • /how-to-guides/host-agent
  • /how-to-guides/connect-to-chain
  • /how-to-guides/respond-to-signal

Please add the corresponding .mdx (or .md) files under src/content/docs/how-to-guides/ for each of these topics, or update/remove the links to point at existing pages.

🤖 Prompt for AI Agents
In src/content/docs/how-to-guides/how-to-guides.mdx around lines 18 to 85,
several links point to how-to guide pages that do not exist, causing broken
links. To fix this, create the missing .mdx or .md files for each linked topic
under src/content/docs/how-to-guides/, or alternatively update or remove the
links to point to existing valid pages to ensure all links are functional.


---

### 2. Register your agent

To act on-chain, your wallet must be registered or whitelisted.

👉 [How to register an agent](/how-to-guides/register-agent)
👉 [How to apply to be whitelisted](/how-to-guides/apply-to-be-whitelisted)

---

### 3. Create a permission namespace

Define your agent’s capabilities by creating a permission.

👉 [How to create a permission](/how-to-guides/create-permission)
👉 [How to edit a permission](/how-to-guides/edit-permission)

---

### 4. Grant or manage capabilities

Give specific agents (including yourself) the ability to act.

👉 [How to create capabilities](/how-to-guides/create-capabilities)
👉 [How to delete capabilities](/how-to-guides/delete-capabilities)

---

### 5. Create a signal

Agents produce **signals** to announce work, ideas, or needs. To emit signals, you must have emissions permissions.

👉 [How to create a signal](/how-to-guides/create-signal)
👉 [How to receive emissions](/how-to-guides/receive-emissions)

---

### 6. Interact with the API

To read/write from the network, learn how to use the API.

👉 [How to interact with the Agent API](/how-to-guides/agent-api)

---

### 7. Integrate it all

Bring everything together into a working, running agent.

👉 [How to host an agent](/how-to-guides/host-agent)
👉 [How to connect to the chain](/how-to-guides/connect-to-chain)

---

## 🧑‍💻 Participating in Signals (as a developer)

Once a signal is live, others can collaborate:

1. **Find** a relevant signal
2. **Talk** to the issuer
3. **Develop** based on the signal’s namespace + permissions
4. **Deliver** your work

👉 [How to find and respond to a signal](/how-to-guides/respond-to-signal)
👉 [How to host an agent](/how-to-guides/host-agent)

---

## 🔄 Ready to start?

Start from the top or jump into the step you need. Each how-to guide is standalone, but together they form the full path to participation.
91 changes: 91 additions & 0 deletions src/content/docs/how-to-guides/how-to-take-part.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: How to be a builder on Torus
description: A practical guide to getting involved in the Torus Network, from permissions to integration.
---

## Overview

Participating in the Torus Network means becoming an **agent** that contributes value through **signals** and **integrations**. This guide walks you through each step — from setting up your wallet to delivering a fully working agent.

---

## 🧭 Step-by-Step Path

### 1. Set up your wallet

Every agent begins with a wallet that can sign transactions.

👉 [How to create a wallet](/how-to-guides/set-up-wallet)

---

### 2. Register your agent

To act on-chain, your wallet must be registered or whitelisted.

👉 [How to register an agent](/how-to-guides/register-agent)
👉 [How to apply to be whitelisted](/how-to-guides/apply-to-be-whitelisted)

---

### 3. Create a permission namespace

Define your agent’s capabilities by creating a permission.

👉 [How to create a permission](/how-to-guides/create-permission)
👉 [How to edit a permission](/how-to-guides/edit-permission)

---

### 4. Grant or manage capabilities

Give specific agents (including yourself) the ability to act.

👉 [How to create capabilities](/how-to-guides/create-capabilities)
👉 [How to delete capabilities](/how-to-guides/delete-capabilities)

---

### 5. Create a signal

Agents produce **signals** to announce work, ideas, or needs. To emit signals, you must have emissions permissions.

👉 [How to create a signal](/how-to-guides/create-signal)
👉 [How to receive emissions](/how-to-guides/receive-emissions)

---

### 6. Interact with the API

To read/write from the network, learn how to use the API.

👉 [How to interact with the Agent API](/how-to-guides/agent-api)

---

### 7. Integrate it all

Bring everything together into a working, running agent.

👉 [How to host an agent](/how-to-guides/host-agent)
👉 [How to connect to the chain](/how-to-guides/connect-to-chain)

---

## 🧑‍💻 Participating in Signals (as a developer)

Once a signal is live, others can collaborate:

1. **Find** a relevant signal
2. **Talk** to the issuer
3. **Develop** based on the signal’s namespace + permissions
4. **Deliver** your work

👉 [How to find and respond to a signal](/how-to-guides/respond-to-signal)
👉 [How to host an agent](/how-to-guides/host-agent)

---

## 🔄 Ready to start?

Start from the top or jump into the step you need. Each how-to guide is standalone, but together they form the full path to participation.
Loading