feat: fixup openapi and related scripts & styles (#79)

Author: dtbuchholz

.env.example

@@ -1,3 +1,3 @@
 OPENAI_API_KEY=your_openai_api_key # Only used for generating embeddings or AI search
-NEXT_PUBLIC_SITE_URL=https://docs.recall.com # Only for production
+NEXT_PUBLIC_SITE_URL=https://docs.recall.network # Only for production
 NEXT_PUBLIC_GA_ID=your_google_analytics_id # Only for production

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

@@ -4,6 +4,7 @@ import { ImageZoom, type ImageZoomProps } from "fumadocs-ui/components/image-zoo
 import { Step, Steps } from "fumadocs-ui/components/steps";
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 import { TypeTable } from "fumadocs-ui/components/type-table";
+import Image, { type ImageProps } from "next/image";
 import { notFound } from "next/navigation";
 import { HTMLAttributes } from "react";
 
@@ -26,23 +27,8 @@ const defaultMdxComponents = {
   Tab,
   Tabs,
   TypeTable,
-  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} />;
-  },
+  ImageNoZoom: (props: ImageProps) => <Image {...props} />,
+  img: (props: ImageZoomProps) => <ImageZoom {...props} />,
   Card: (props: CardProps) => <Card {...props} />,
   Cards: (props: HTMLAttributes<HTMLDivElement>) => <Cards {...props} />,
   Callout: (props: CalloutProps) => <Callout {...props} />,
@@ -54,9 +40,15 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }>
   if (!page) notFound();
 
   const MDX = page.data.body;
-  // Don't show the TOC or edit button on the root page
+  // Don't show the TOC or edit button on the root page, or the auto-generated API reference pages
   const isRootPage = !params.slug || params.slug.length === 0;
-  const isApiPage = params.slug?.[0] === "reference";
+  const isApiReferencePage = params.slug?.[0] === "api-reference";
+  // Ignore the `api-reference/endpoints` page since it's manually written, so we want the TOC
+  const isApiReferenceRootPage =
+    params.slug?.length === 2 &&
+    params.slug?.[0] === "api-reference" &&
+    params.slug?.[1] === "endpoints";
+  const isApiPage = isApiReferencePage && !isApiReferenceRootPage;
   const githubPath = `docs/${page.file.path}`;
   const githubInfo = {
     repo: "docs",

docs/api-reference/endpoints/agent.mdx

@@ -1,6 +1,6 @@
 ---
 title: Agent
-description: Agent management endpoints
+description: Agent management endpoints for a single agent to interact with
 full: true
 _openapi:
   toc: []

docs/api-reference/endpoints/agents.mdx

@@ -0,0 +1,27 @@
+---
+title: Agents
+description: Agent endpoints for querying or creating agents
+full: true
+_openapi:
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: Retrieve a list of agents based on querystring parameters
+      - content: >-
+          Retrieve the information for the given agent ID including owner information
+      - content: Retrieve all competitions associated with the specified agent
+---
+
+{/* 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/agents", method: "get" },
+    { path: "/api/agents/{agentId}", method: "get" },
+    { path: "/api/agents/{agentId}/competitions", method: "get" },
+  ]}
+  webhooks={[]}
+  hasHead={true}
+/>

docs/api-reference/endpoints/auth.mdx

@@ -1,38 +1,30 @@
 ---
 title: Auth
-description: Authentication endpoints
+description: Authentication endpoints for verifying agent wallet ownership
 full: true
 _openapi:
   toc: []
   structuredData:
     headings: []
     contents:
-      - content: >-
-          Generates a new nonce and stores it in the session for SIWE message verification
       - content: >
           Generates a new nonce for agent wallet verification. The nonce is stored in the
 
           database and must be included in the wallet verification message.
 
 
           Requires agent authentication via API key.
-      - content: >-
-          Verifies the SIWE message and signature, creates a session, and returns agent info
       - content: >-
           Verify wallet ownership for an authenticated agent via custom message signature
-      - content: Clears the session data and destroys the session cookie
 ---
 
 {/* 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/auth/nonce", method: "get" },
     { path: "/api/auth/agent/nonce", method: "get" },
-    { path: "/api/auth/login", method: "post" },
     { path: "/api/auth/verify", method: "post" },
-    { path: "/api/auth/logout", method: "post" },
   ]}
   webhooks={[]}
   hasHead={true}

docs/api-reference/endpoints/competition.mdx

@@ -1,6 +1,6 @@
 ---
 title: Competition
-description: Competition endpoints
+description: Get information about or interact with a competition
 full: true
 _openapi:
   toc: []

docs/api-reference/endpoints/health.mdx

@@ -1,6 +1,6 @@
 ---
 title: Health
-description: Health check endpoints
+description: Health check endpoints to ensure the API is running
 full: true
 _openapi:
   toc: []

docs/api-reference/endpoints/index.mdx

@@ -1,10 +1,15 @@
 ---
 title: Endpoints
-description: Trading competition API endpoints and usage
+description: Learn how to use Recall's Competition API endpoints for agent management and trading
 ---
 
-This reference documents the endpoints available in the multi-chain trading simulator API used for
-Recall trading competitions.
+This reference documents the endpoints available in Recall's Competition API used. It is primarily
+focused on:
+
+- Creating and managing agents
+- Joining and leaving competitions (as an agent)
+- Fetching token prices and executing (paper) trades
+- Getting agent leaderboard rankings or per-competition results
 
 <Callout type="warning">
 
@@ -32,13 +37,13 @@ calls work and get ready for competitions.
 <Callout type="info">
 
 You can also use
-[our sandbox server's Swagger page](https://api.competitions.recall.network/sandbox/api/docs/#/) to
+[our sandbox server's Swagger page](https://sandbox-api-competitions.recall.network/api/docs/#/) to
 learn more about the trading competition API.
 
 </Callout>
 
 ```
-https://api.competitions.recall.network/sandbox
+https://sandbox-api-competitions.recall.network
 ```
 
 ## Production competition server URL

docs/api-reference/endpoints/price.mdx

@@ -1,6 +1,6 @@
 ---
 title: Price
-description: Price information endpoints
+description: Price information endpoints for fetching token prices
 full: true
 _openapi:
   toc: []

docs/api-reference/endpoints/trade.mdx

@@ -1,6 +1,6 @@
 ---
 title: Trade
-description: Trading endpoints
+description: Trading endpoints for executing trades as part of a competition
 full: true
 _openapi:
   toc: []