Skip to content

Commit 6328617

Browse files
feat: reorganize docs (#129)
- Simplify the introductory conceptual pages to convey main ideas quickly. - e.g. add airdrop info to the token page, since most airdrop recipients have already claimed. - Reduce five categories to three by deleting Advanced and consolidating Token into other sections. - Update language everywhere (e.g. vote > boost). - Link between relevant pages (e.g. token info <> how to stake/boost). - Remove outdated logic fetching paper trading competition info from the app. Co-authored-by: carsonfarmer <[email protected]>
1 parent f486a7b commit 6328617

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1755
-2404
lines changed

README.md

Lines changed: 0 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -48,73 +48,6 @@ pnpm build
4848
pnpm start
4949
```
5050

51-
### Competition Configuration
52-
53-
This directory contains configuration files for Recall competitions. The data in these files is used
54-
to generate the competition schedule and other competition-related information in the documentation.
55-
56-
#### Configuration File
57-
58-
The `competitions.json` file (located in the `data` directory) contains information about all Recall
59-
competitions, including:
60-
61-
- `id`: Unique identifier for the competition
62-
- `name`: Display name for the competition
63-
- `status`: Current status (e.g., "OPEN", "Coming Soon", "CLOSED")
64-
- `submissionDeadline`: Deadline for submissions
65-
- `resultsDate`: Date when results will be announced
66-
- `url`: URL to the competition page (or null if not available)
67-
68-
#### Managing Competitions
69-
70-
Several npm scripts are available to manage competition data:
71-
72-
##### List all competitions
73-
74-
```bash
75-
pnpm competition:list
76-
```
77-
78-
##### Add a new competition
79-
80-
```bash
81-
pnpm competition:add <id> <name> <status> <submission-deadline> <results-date> [url]
82-
```
83-
84-
Example:
85-
86-
```bash
87-
pnpm competition:add gamma-test "Gamma Test" "Coming Soon" "December 15, 2023" "January 15, 2024" "/competitions/gamma-test"
88-
```
89-
90-
##### Update a competition
91-
92-
```bash
93-
pnpm competition:update <competition-id> <field> <value>
94-
```
95-
96-
Example:
97-
98-
```bash
99-
pnpm competition:update alpha-wave status "CLOSED"
100-
```
101-
102-
#### Implementation Details
103-
104-
The competition data is loaded in two ways:
105-
106-
1. In the `CompetitionSchedule` component, which generates the competition schedule table
107-
2. In individual competition pages that need to display competition dates
108-
109-
The configuration file is accessed using a relative path from the project root:
110-
111-
```javascript
112-
const filePath = path.join(process.cwd(), "app", "data", "competitions.json");
113-
```
114-
115-
This approach allows us to maintain competition information in a single source of truth, making it
116-
easier to update dates and statuses.
117-
11851
### AI Chat & Embeddings
11952

12053
Optionally, set up an `OPENAI_API_KEY` environment variable to enable embeddings for the search

app/[[...slug]]/page.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }>
4444
const MDX = page.data.body;
4545
// Don't show the TOC or edit button on the root page, or the auto-generated API reference pages
4646
const isRootPage = !params.slug || params.slug.length === 0;
47-
const isApiReferencePage = params.slug?.[0] === "api-reference";
48-
// Ignore the `api-reference/endpoints` page since it's manually written, so we want the TOC
47+
const isApiReferencePage = params.slug?.[0] === "reference" && params.slug?.[1] === "endpoints";
48+
// Ignore the `reference/endpoints` index page since it's manually written, so we want the TOC
4949
const isApiReferenceRootPage =
5050
params.slug?.length === 2 &&
51-
params.slug?.[0] === "api-reference" &&
51+
params.slug?.[0] === "reference" &&
5252
params.slug?.[1] === "endpoints";
5353
const isApiPage = isApiReferencePage && !isApiReferenceRootPage;
5454
const githubPath = `docs/${page.file.path}`;

app/data/competitions.json

Lines changed: 0 additions & 28 deletions
This file was deleted.

app/layout.config.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Link as LinkIcon, PartyPopper } from "lucide-react";
1+
import { Link as LinkIcon, Zap } from "lucide-react";
22
import Image from "next/image";
33
import Link from "next/link";
44
import { FaDiscord, FaGithub, FaXTwitter } from "react-icons/fa6";
@@ -58,8 +58,8 @@ export const baseOptions: BaseLayoutProps = {
5858
href="https://claim.recall.network/"
5959
className="text-fd-primary hover:text-fd-primary/80 inline-flex items-center font-bold transition-colors duration-200"
6060
>
61-
<PartyPopper size={16} className="mr-2" />
62-
RECALL airdrop claims are open!
61+
<Zap size={16} className="mr-2" />
62+
Boost agents to earn more RECALL!
6363
<LinkIcon size={16} className="ml-1" />
6464
</Link>
6565
</>

components/competition-schedule.tsx

Lines changed: 0 additions & 49 deletions
This file was deleted.

components/landing-page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const features = [
1717
{
1818
icon: <PartyPopper className="text-blue h-6 w-6" />,
1919
title: "Predict winning agents",
20-
href: "/competitions/user-guides/vote",
20+
href: "/competitions/user-guides/boost",
2121
description: "Earn rewards by identifying top performers",
2222
},
2323
{

docs/advanced.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/competitions/7-day-trading-challenge.mdx

Lines changed: 0 additions & 122 deletions
This file was deleted.

docs/competitions/developer-guides/eliza.mdx renamed to docs/competitions/build-agent/eliza.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Five Minute Eliza Trader
2+
title: Eliza quickstart
33
description: Build and run a Recall-trading AI agent with ElizaOS.
44
---
55

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Build your agent
3+
description: Learn how to build and develop AI trading agents for Recall competitions
4+
---
5+
6+
Build powerful AI trading agents using popular frameworks and tools. These guides will help you develop, test, and deploy trading strategies for competition.
7+
8+
## Building your agent
9+
10+
1. **Make your first trade**: Learn the basics of the paper trading API
11+
2. **Choose a framework**: Select from Eliza, Mastra, or build your own
12+
3. **Implement trading logic**: Develop your agent's trading strategies
13+
4. **Deploy your agent**: Host your agent using Vercel or your own infrastructure
14+
15+
## Development guides
16+
17+
<Cards>
18+
<Card
19+
title="Make your first trade"
20+
description="Learn how to use our paper trading API"
21+
href="/competitions/build-agent/your-first-trade"
22+
/>
23+
<Card
24+
title="Build with Eliza"
25+
description="Create an agent using the Eliza framework"
26+
href="/competitions/build-agent/eliza"
27+
/>
28+
<Card
29+
title="Build with Mastra"
30+
description="Develop your agent using Mastra"
31+
href="/competitions/build-agent/mastra"
32+
/>
33+
<Card
34+
title="Trading strategies"
35+
description="Implement effective trading strategies"
36+
href="/competitions/build-agent/trading"
37+
/>
38+
<Card
39+
title="Deploy with Vercel"
40+
description="Host your agent on Vercel"
41+
href="/competitions/build-agent/vercel"
42+
/>
43+
</Cards>

0 commit comments

Comments
 (0)