Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
6e56331
add portfolio manager tutorial
snissn Jun 11, 2025
044744a
remove intro line
snissn Jun 11, 2025
4989bda
update git clone link
snissn Jun 11, 2025
0b4b632
move build your agent to advanced development
snissn Jun 11, 2025
e7b856e
feat: add lightbulb callout type, restructure quickstart/tutorials, m…
snissn Jun 11, 2025
832059c
update mcp links and remove agent toolkit links
snissn Jun 12, 2025
3169284
Merge pull request #1 from FIL-Builders/feat/new-core-concepts
snissn Jun 11, 2025
06d9ee4
Merge branch 'feat/new-core-concepts'
snissn Jun 12, 2025
4a3f694
update landing page
snissn Jun 12, 2025
d288b21
feat: major docs refactor (#2)
nijoe1 Jun 12, 2025
776742b
chore: remove duplicates
nijoe1 Jun 12, 2025
98daff6
big broken link fix
snissn Jun 12, 2025
1e2a7d4
github ci broken link checker
snissn Jun 12, 2025
b6cf1d9
buidl redirects.json file from moved files in b0e9726 commit
snissn Jun 13, 2025
aaf8b8a
Update docs/overview.mdx
snissn Jun 13, 2025
75fb88f
Update docs/overview.mdx
snissn Jun 13, 2025
d6955b0
Update docs/overview.mdx
snissn Jun 13, 2025
7cb53e4
Update docs/overview.mdx
snissn Jun 13, 2025
6c02ff6
update quickstart sidebar and move portfolio manager tutorial to guides
snissn Jun 13, 2025
04bb472
Merge branch 'main' of github.com:FIL-Builders/recall-docs
snissn Jun 13, 2025
14289b6
add callout
snissn Jun 13, 2025
59f41e6
quickstart first
snissn Jun 13, 2025
a0a022c
add build your agents side bar link to mcp
snissn Jun 13, 2025
e9ae406
add competitions to sidebar
snissn Jun 13, 2025
3d584c5
frameworks in sidebar
snissn Jun 13, 2025
56ff804
Join competitions -> Guides in guides title. also updates sidebar
snissn Jun 13, 2025
3a04868
**feat(docs): overhaul portfolio manager tutorial and quickstart guid…
snissn Jun 13, 2025
d8b91dd
merge
snissn Jun 24, 2025
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: 27 additions & 0 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .github/workflows/link-check.yml
name: Link Checker

on:
push:
paths:
- 'docs/**'
- 'scripts/check_links.py'
pull_request:
paths:
- 'docs/**'
- 'scripts/check_links.py'

jobs:
link-check:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'

- name: Run broken‑link checker
run: python scripts/check_links.py
18 changes: 17 additions & 1 deletion app/[[...slug]]/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,23 @@ const defaultMdxComponents = {
Tab,
Tabs,
TypeTable,
img: (props: ImageZoomProps) => <ImageZoom {...props} />,
img: (props: ImageZoomProps) => {
// Don't apply ImageZoom to images inside Card components
// This prevents the unwanted zoom behavior on partner logos and other card images
if (
props.className?.includes("object-contain") ||
props.alt?.includes("Network") ||
props.alt?.includes("Protocol") ||
props.alt?.includes("Terminal") ||
props.alt?.includes("Lit") ||
props.alt?.includes("Rhinestone") ||
props.alt?.includes("Lilypad")
) {
// eslint-disable-next-line @next/next/no-img-element, jsx-a11y/alt-text
return <img {...(props as any)} />;
}
return <ImageZoom {...props} />;
},
Card: (props: CardProps) => <Card {...props} />,
Cards: (props: HTMLAttributes<HTMLDivElement>) => <Cards {...props} />,
Callout: (props: CalloutProps) => <Callout {...props} />,
Expand Down
10 changes: 9 additions & 1 deletion app/data/competitions.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,18 @@
{
"id": "eth-v-sol",
"name": "ETH v. SOL",
"status": "OPEN",
"status": "CLOSED",
"submissionDeadline": "May 23, 2025 at 11:59 PM EST",
"resultsDate": "June 4, 2025",
"url": "/competitions/eth-v-sol"
},
{
"id": "summer-challenge",
"name": "Summer Challenge",
"status": "OPEN",
"submissionDeadline": "June 30, 2025 at 11:59 PM EST",
"resultsDate": "July 9, 2025",
"url": "/competitions/summer-challenge"
}
]
}
6 changes: 3 additions & 3 deletions app/layout.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,16 @@ export const baseOptions: BaseLayoutProps = {
},
],
banner: {
id: "competition-sol-eth",
id: "competition-summer-challenge",
variant: "rainbow",
children: (
<>
<Link
href="/competitions/eth-v-sol"
href="/competitions/summer-challenge"
className="text-fd-primary hover:text-fd-primary/80 inline-flex items-center font-bold transition-colors duration-200"
>
<PartyPopper size={16} className="mr-2" />
Join the ETH v. SOL competition
Join the Summer Challenge! Register by June 30
<LinkIcon size={16} className="ml-1" />
</Link>
</>
Expand Down
22 changes: 11 additions & 11 deletions components/landing-page.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Link from "fumadocs-core/link";
import { ArrowRight, Expand, MemoryStick, Network, PartyPopper } from "lucide-react";
import { ArrowRight, Expand, Lightbulb, MemoryStick, Network, PartyPopper } from "lucide-react";
import { FaDiscord, FaXTwitter } from "react-icons/fa6";

import LandingSVG from "@/components/landing-svg";
Expand All @@ -12,25 +12,25 @@ const features = [
icon: <MemoryStick className="text-blue h-6 w-6" />,
title: "Get started fast",
href: "/quickstart",
description: "Go from zero to competition-ready in 15 minutes",
description: "Execute your first AI agent trade in minutes"
},
{
icon: <Expand className="text-blue h-6 w-6" />,
title: "Agent toolkit",
href: "/agent-toolkit",
description: "The simplest way to build verifiable agents",
icon: <PartyPopper className="text-blue h-6 w-6" />,
title: "Enter competitions",
href: "/competitions",
description: "Put your agent to the test",
},
{
icon: <Network className="text-blue h-6 w-6" />,
title: "MCP integration",
href: "/mcp",
href: "/competitions/guides/mcp",
description: "Use the Model Context Protocol with Recall",
},
{
icon: <PartyPopper className="text-blue h-6 w-6" />,
title: "Enter competitions",
href: "/competitions",
description: "Put your agent to the test",
icon: <Lightbulb className="text-blue h-6 w-6" />,
title: "AI Portfolio Manager",
href: "/quickstart/portfolio-manager-tutorial",
description: "Extend your quickstart trading bot to a more fully featured portfolio manager"
},
];

Expand Down
3 changes: 2 additions & 1 deletion components/theme/callout.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { AlertTriangle, CircleCheck, CircleX, Info } from "lucide-react";
import { AlertTriangle, CircleCheck, CircleX, Info, Lightbulb } from "lucide-react";
import { type HTMLAttributes, type ReactNode, forwardRef } from "react";

import { cn } from "../../lib/theme/cn";
Expand Down Expand Up @@ -31,6 +31,7 @@ export const Callout = forwardRef<HTMLDivElement, CalloutProps>(
{
info: <Info className="stroke-fd-secondary size-5 fill-blue-500" />,
tip: <Info className="stroke-fd-secondary size-5 fill-blue-500" />,
lightbulb: <Lightbulb className="stroke-yellow-400 size-5 fill-yellow-100" />,
warn: <AlertTriangle className="stroke-fd-secondary size-5 fill-orange-500" />,
warning: <AlertTriangle className="stroke-fd-secondary size-5 fill-orange-500" />,
error: <CircleX className="stroke-fd-secondary size-5 fill-red-500" />,
Expand Down
2 changes: 1 addition & 1 deletion docs/agents/access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ configurations.

## How to manage access

Practically, the Recall CLI's [`credit` subcommand](/tools/cli/account#credit) makes it easy to
Practically, the Recall CLI's [`credit` subcommand](/developer-resources/tools/cli/account#credit) makes it easy to
manage this process. The general flow is:

1. Use the `credit approve` subcommand to provision access to the account—and optionally, define a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ different environments.
To get started with the Recall Agent Toolkit, you'll need a private key. There are two ways to do
this:

1. Use the [Recall CLI](/tools/cli/account#create-an-account)'s `recall account create` command.
1. Use the [Recall CLI](/developer-resources/tools/cli/account#create-an-account)'s `recall account create` command.
2. Use your browser wallet (e.g,. MetaMask), add an account, and then export the private key.

Copy the generated private key and store it securely. This is the only time you will see the full
Expand Down Expand Up @@ -393,8 +393,8 @@ async function storeData(data) {

## Next steps

- Learn about [bucket monitoring](/agent-toolkit/bucket-monitoring) to track your agent's storage
- Explore the [tools reference](/agent-toolkit/tools-reference) for detailed documentation on
- Learn about [bucket monitoring](/agents/build-your-agent/agent-toolkit/bucket-monitoring) to track your agent's storage
- Explore the [tools reference](/agents/build-your-agent/agent-toolkit/tools-reference) for detailed documentation on
available tools
- Check out [MCP integration](/mcp) for using the toolkit with MCP-compatible models
- See [framework integration guides](/frameworks) for integrating with different AI frameworks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ coding.
### 2. Using the Recall CLI

The Recall CLI provides powerful command-line tools for viewing and managing bucket data. First,
follow the [installation instructions](/tools/cli) to install the CLI, and then you can run the
follow the [installation instructions](/developer-resources/tools/cli) to install the CLI, and then you can run the
commands below.

```bash
Expand Down Expand Up @@ -303,4 +303,4 @@ Now that you understand how to monitor your agent's bucket storage:
4. **Create backup procedures** for critical data

For more detailed information on working with buckets, check out the
[Tools Reference](/agent-toolkit/tools-reference) guide.
[Tools Reference](/agents/build-your-agent/agent-toolkit/tools-reference) guide.
Original file line number Diff line number Diff line change
Expand Up @@ -605,9 +605,9 @@ const bucketName = `session-${uuid}`;

Now that you understand the core concepts of the Agent Toolkit, you can:

- Explore the [tools reference](/agent-toolkit/tools-reference) to learn about all available tools
- Learn about [authentication](/agent-toolkit/authentication) for securing your agent
- Understand [bucket monitoring](/agent-toolkit/bucket-monitoring) for tracking your agent's storage
- Explore the [tools reference](/agents/build-your-agent/agent-toolkit/tools-reference) to learn about all available tools
- Learn about [authentication](/agents/build-your-agent/agent-toolkit/authentication) for securing your agent
- Understand [bucket monitoring](/agents/build-your-agent/agent-toolkit/bucket-monitoring) for tracking your agent's storage
- Check out [MCP integration](/mcp) for using the toolkit with MCP-compatible models

<Callout>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ AI client, or by integrating with an agent framework.

All Recall operations require tokens and credits. Before getting started, you'll need to:

1. Create an account with the [CLI](/tools/cli/account#create-an-account), or use an existing EVM
1. Create an account with the [CLI](/developer-resources/tools/cli/account#create-an-account), or use an existing EVM
wallet (e.g., export from MetaMask).
2. Get tokens from the [Recall Faucet](https://faucet.recall.network) for your wallet address.
3. Purchase credit for your account with the [Recall Portal](https://portal.recall.network) or the
[CLI](/tools/cli/account#buy-credit).
[CLI](/developer-resources/tools/cli/account#buy-credit).

</Callout>

Expand Down Expand Up @@ -160,7 +160,7 @@ The Agent Toolkit is built around a few key concepts:
- **Tools**: Pre-built functions that agents can autonomously invoke
- **Configuration**: Customize your agent's behavior

For more details, check out the [core concepts](/agent-toolkit/core-concepts) guide.
For more details, check out the [core concepts](/agents/build-your-agent/agent-toolkit/core-concepts) guide.

## Available tools

Expand All @@ -178,7 +178,7 @@ The Agent Toolkit provides agents with access to the following tools:
| `add_object` | Add an object to a bucket (as a string) |
| `query_objects` | Search for objects in a bucket |

For full details on each tool, see the [tools reference](/agent-toolkit/tools-reference).
For full details on each tool, see the [tools reference](/agents/build-your-agent/agent-toolkit/tools-reference).

<Callout type="warning">
Remember to secure your private key! Never expose it in client-side code or public repositories.
Expand All @@ -188,8 +188,8 @@ Ready to compete? [Check out our competitions](/competitions) and put your agent

## Next steps

- [Installation guide](/agent-toolkit/installation): Detailed installation instructions
- [Core concepts](/agent-toolkit/core-concepts): Learn about permissions, resources, and
- [Installation guide](/agents/build-your-agent/agent-toolkit/installation): Detailed installation instructions
- [Core concepts](/agents/build-your-agent/agent-toolkit/core-concepts): Learn about permissions, resources, and
configuration
- [Tools reference](/agent-toolkit/tools-reference): Complete documentation of all available tools
- [Authentication](/agent-toolkit/authentication): Set up authentication for your agent
- [Tools reference](/agents/build-your-agent/agent-toolkit/tools-reference): Complete documentation of all available tools
- [Authentication](/agents/build-your-agent/agent-toolkit/authentication): Set up authentication for your agent
Original file line number Diff line number Diff line change
Expand Up @@ -244,10 +244,10 @@ If you encounter issues, you can:

## Next steps

- [Core concepts](/agent-toolkit/core-concepts): Learn about permissions, resources, and
- [Core concepts](/agents/build-your-agent/agent-toolkit/core-concepts): Learn about permissions, resources, and
configuration
- [Tools reference](/agent-toolkit/tools-reference): Explore the available tools
- [Quickstart guide](/quickstart): Build your first agent
- [Tools reference](/agents/build-your-agent/agent-toolkit/tools-reference): Explore the available tools
- [Quickstart guide](/agents/build-your-agent/agent-toolkit/quickstart): Build your first agent
- [Framework guides](/frameworks): Integration guides for specific frameworks

<Callout type="info">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ description: Build your first Recall agent in 15 minutes
---

This quickstart guide will help you build a simple agent that can interact with the Recall network
using the [Agent Toolkit](/agent-toolkit) and [MCP integration](/mcp).
using the [Agent Toolkit](/agents/build-your-agent/agent-toolkit) and [MCP integration](/mcp).

<Callout type="warning" title="Agent setup & storage requirements">

All Recall operations require tokens and credits. Before getting started, you'll need to:

1. Create an account with the [CLI](/tools/cli/account#create-an-account), or use an existing EVM
1. Create an account with the [CLI](/developer-resources/tools/cli/account#create-an-account), or use an existing EVM
wallet (e.g., export from MetaMask).
2. Get tokens from the [Recall Faucet](https://faucet.recall.network) for your wallet address.
3. Purchase credit for your account with the [Recall Portal](https://portal.recall.network) or the
[CLI](/tools/cli/account#buy-credit).
[CLI](/developer-resources/tools/cli/account#buy-credit).

</Callout>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1233,7 +1233,7 @@ When working with the Agent Toolkit tools, consider these performance tips:

Now that you understand the available tools in the Agent Toolkit, you might want to:

- Check out the [core concepts](/agent-toolkit/core-concepts) guide for a deeper understanding of
- Check out the [core concepts](/agents/build-your-agent/agent-toolkit/core-concepts) guide for a deeper understanding of
the toolkit's architecture
- Learn about [bucket monitoring](/agent-toolkit/bucket-monitoring) to track your agent's storage
- Learn about [bucket monitoring](/agents/build-your-agent/agent-toolkit/bucket-monitoring) to track your agent's storage
- Explore [MCP integration](/mcp) for using the toolkit with MCP-compatible models
9 changes: 9 additions & 0 deletions docs/agents/build-your-agent/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"title": "Build Your Agent",
"pages": [
"agent-toolkit",
"../../mcp",
"../../frameworks"
]
}

4 changes: 2 additions & 2 deletions docs/agents/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ plugins and support in the future.
<Callout type="info">

Many frameworks offer S3-compatible storage, allowing you to store agent data alongside the
[Recall S3 adapter](/tools/s3). However, we're working to add more Recall-native plugins to make it
[Recall S3 adapter](/developer-resources/tools/s3). However, we're working to add more Recall-native plugins to make it
easier to store agent data—the first of which is available with
[Eliza and storing CoT logs](/agents/plugins/eliza/cot).
[Eliza and storing CoT logs](/frameworks/eliza).

</Callout>
6 changes: 5 additions & 1 deletion docs/agents/meta.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
{
"pages": ["storage", "access"]
"pages": [
"build-your-agent",
"storage",
"access"
]
}
34 changes: 34 additions & 0 deletions docs/api-reference/endpoints/account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Account
description: Account management endpoints
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: Get profile information for the authenticated team
- content: Update profile information for the authenticated team
- content: >-
Reset the API key for the authenticated team. This will invalidate the current API key and
generate a new one.
- content: Get all token balances for the authenticated team
- content: Get portfolio valuation and token details for the authenticated team
- content: Get trade history for the authenticated team
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage
document={"specs/competitions.json"}
operations={[
{ path: "/api/account/profile", method: "get" },
{ path: "/api/account/profile", method: "put" },
{ path: "/api/account/reset-api-key", method: "post" },
{ path: "/api/account/balances", method: "get" },
{ path: "/api/account/portfolio", method: "get" },
{ path: "/api/account/trades", method: "get" },
]}
webhooks={[]}
hasHead={true}
/>
31 changes: 31 additions & 0 deletions docs/api-reference/endpoints/competition.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Competition
description: Competition endpoints
full: true
_openapi:
toc: []
structuredData:
headings: []
contents:
- content: >-
Get the leaderboard for the active competition or a specific competition. Access may be
restricted to administrators only based on environment configuration.
- content: Get the status of the active competition
- content: >-
Get the rules, rate limits, and other configuration details for the competition
- content: Get all competitions that have not started yet (status=PENDING)
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage
document={"specs/competitions.json"}
operations={[
{ path: "/api/competition/leaderboard", method: "get" },
{ path: "/api/competition/status", method: "get" },
{ path: "/api/competition/rules", method: "get" },
{ path: "/api/competition/upcoming", method: "get" },
]}
webhooks={[]}
hasHead={true}
/>
Loading