Skip to content

Commit 0ba0db6

Browse files
committed
Organize guides and resources.
1 parent 2fef6a1 commit 0ba0db6

File tree

200 files changed

+442
-377
lines changed

Some content is hidden

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

200 files changed

+442
-377
lines changed

.github/scripts/update-example-dates.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,10 @@ async function updateExampleDates() {
9090
console.log("Parsing repositories from MDX file...");
9191

9292
// Read the current MDX file
93-
const mdxPath = path.join(__dirname, "../../app/en/home/examples/page.mdx");
93+
const mdxPath = path.join(
94+
__dirname,
95+
"../../app/en/resources/examples/page.mdx"
96+
);
9497
let content = fs.readFileSync(mdxPath, "utf8");
9598

9699
// Parse repositories from the MDX file

.github/workflows/translate-docs.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ on:
3232
type: boolean
3333

3434
single_file:
35-
description: "Single file to translate (relative to app/en, e.g. 'home/page.mdx')"
35+
description: "Single file to translate (relative to app/en, e.g. 'resources/examples/page.mdx')"
3636
required: false
3737
default: ""
3838
type: string
@@ -121,14 +121,14 @@ jobs:
121121
else
122122
echo "Changes detected"
123123
echo "has_changes=true" >> $GITHUB_OUTPUT
124-
124+
125125
# Count changed files
126126
CHANGED_FILES=$(git diff --name-only | wc -l)
127127
STAGED_FILES=$(git diff --cached --name-only | wc -l)
128128
TOTAL_CHANGES=$((CHANGED_FILES + STAGED_FILES))
129-
129+
130130
echo "changed_files=$TOTAL_CHANGES" >> $GITHUB_OUTPUT
131-
131+
132132
# Get list of changed locales
133133
CHANGED_LOCALES=$(git diff --name-only | grep -E '^app/(es|pt-BR)/' | cut -d'/' -f2 | sort -u | tr '\n' ',' | sed 's/,$//')
134134
if [ -z "$CHANGED_LOCALES" ]; then
@@ -213,22 +213,22 @@ jobs:
213213
head: '${{ steps.branch_name.outputs.branch_name }}',
214214
base: 'main',
215215
body: `## 📖 Automated Translation Update
216-
216+
217217
This PR contains automated translations generated by the GitHub Actions workflow.
218-
218+
219219
### 📊 Translation Summary
220220
- **Target Locale**: ${{ inputs.target_locale }}
221221
- **Files Changed**: ${{ steps.check_changes.outputs.changed_files }}
222222
- **Locales Updated**: ${{ steps.check_changes.outputs.changed_locales }}
223-
223+
224224
### ⚙️ Configuration Used
225225
- **Force Translate**: ${{ inputs.force_translate }}
226226
- **Cleanup Deleted Files**: ${{ inputs.cleanup_deleted }}
227227
- **Dry Run**: ${{ inputs.dry_run }}
228228
- **Single File**: ${{ inputs.single_file || 'None (all files)' }}
229229
- **Concurrency**: ${{ inputs.concurrency }}
230230
- **Model**: gpt-4o-mini
231-
231+
232232
### 🔍 Review Guidelines
233233
Please review the translations for:
234234
- [ ] Accuracy and context preservation
@@ -237,10 +237,10 @@ jobs:
237237
- [ ] Code blocks and inline code unchanged
238238
- [ ] Markdown formatting preserved
239239
- [ ] Brand names (Arcade, Arcade Engine, Control Plane) kept in English
240-
240+
241241
### 🚀 Auto-generated
242242
This PR was automatically created by the \`translate-docs.yml\` GitHub Action.
243-
243+
244244
**Triggered by**: @${{ github.actor }}
245245
**Workflow Run**: [${{ github.run_id }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})`,
246246
draft: false

_dictionaries/en.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export default {
99
lastUpdated: "Last updated on",
1010
notFound: "This page could not be found",
1111
poweredBy: "Powered by",
12-
editPage: "Edit this page on GitHub",
12+
editPage: "Edit this page on GitHub",
1313
by: "by",
1414
banner: {
1515
aiTranslation:

app/_components/logo.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
import { Arcade, Badge } from "@arcadeai/design-system";
1+
import { Arcade } from "@arcadeai/design-system";
22
import ArcadeLogo from "@arcadeai/design-system/assets/images/arcade-logo";
33

44
export function Logo() {
55
return (
66
<>
77
<div className="mr-2 hidden w-40 flex-row lg:flex lg:items-end lg:gap-2.5">
88
<ArcadeLogo className="h-7 w-auto invert dark:invert-0" />
9-
<Badge
9+
{/* <Badge
1010
className="relative top-0.5 font-medium font-mono text-xs"
1111
variant="outline"
1212
>
1313
Docs
14-
</Badge>
14+
</Badge> */}
1515
</div>
1616

1717
<div className="mr-16 block w-6 lg:hidden">

app/_components/starter-tool-info.tsx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const StarterToolInfo: React.FC<StarterToolInfoProps> = ({ toolkitName }) => (
1010
<p>
1111
{toolkitName} is a{" "}
1212
<u>
13-
<a href="/home/use-tools/types-of-tools#starter-tools">
13+
<a href="/create-tools/performance/types-of-tools#starter-tools">
1414
Starter MCP Server
1515
</a>
1616
</u>
@@ -21,15 +21,16 @@ const StarterToolInfo: React.FC<StarterToolInfoProps> = ({ toolkitName }) => (
2121
<p>
2222
Differently from{" "}
2323
<u>
24-
<a href="/home/use-tools/types-of-tools#optimized-tools">
24+
<a href="/create-tools/performance/types-of-tools#optimized-tools">
2525
Optimized MCP Servers
2626
</a>
2727
</u>
2828
, Starter tools are heavily influenced by the original API design, which
2929
is not usually optimized for LLM usage. For this reason, we recommend
3030
thoroughly evaluating the tools with your Agents or chatbots before using
31-
it in production. <a href="/home/use-tools/types-of-tools">Read more</a>{" "}
32-
about Optimized vs Starter tools.
31+
it in production.{" "}
32+
<a href="/create-tools/performance/types-of-tools">Read more</a> about
33+
Optimized vs Starter tools.
3334
</p>
3435
</Callout>
3536
);

app/_components/tool-info.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ import {
77
} from "@arcadeai/design-system";
88
import { usePathname } from "next/navigation";
99
import type React from "react";
10-
import { findToolkitFromPath } from "../en/mcp-servers/components/toolkit-utils";
11-
import { TYPE_CONFIG } from "../en/mcp-servers/components/type-config";
10+
import { findToolkitFromPath } from "../en/resources/integrations/components/toolkit-utils";
11+
import { TYPE_CONFIG } from "../en/resources/integrations/components/type-config";
1212

1313
type ToolInfoProps = {
1414
description: string;

app/en/_meta.tsx

Lines changed: 21 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
import { BadgeHelp, Globe, Home, Shield } from "lucide-react";
1+
import {
2+
Book,
3+
BookOpen,
4+
GraduationCap,
5+
Home,
6+
Pencil,
7+
Ruler,
8+
} from "lucide-react";
29
import type { MetaRecord } from "nextra";
310

411
function TitleWithIcon({
@@ -9,7 +16,7 @@ function TitleWithIcon({
916
children: React.ReactNode;
1017
}) {
1118
return (
12-
<span className="flex items-center gap-2 font-medium">
19+
<span className="flex items-center gap-2 font-medium text-gray-950 dark:text-white">
1320
<Icon className="size-4" />
1421
{children}
1522
</span>
@@ -22,143 +29,29 @@ export const meta: MetaRecord = {
2229
copyPage: true,
2330
},
2431
},
25-
index: {
26-
title: <TitleWithIcon icon={Home}>Home</TitleWithIcon>,
32+
home: {
33+
title: <TitleWithIcon icon={Home}>Docs Home</TitleWithIcon>,
2734
theme: {
2835
breadcrumb: false,
2936
layout: "full",
3037
toc: false,
3138
copyPage: false,
3239
},
3340
},
34-
arcade: {
35-
title: <TitleWithIcon icon={Globe}>Arcade.dev</TitleWithIcon>,
36-
href: "https://arcade.dev",
41+
"get-started": {
42+
title: <TitleWithIcon icon={BookOpen}>Get Started</TitleWithIcon>,
3743
},
38-
"-- Getting Started": {
39-
type: "separator",
40-
title: "Using Arcade",
44+
resources: {
45+
title: <TitleWithIcon icon={Pencil}>Resources</TitleWithIcon>,
4146
},
42-
quickstart: {
43-
title: "Calling tools in your agent",
47+
guides: {
48+
title: <TitleWithIcon icon={Ruler}>Guides</TitleWithIcon>,
4449
},
45-
"mcp-gateway-quickstart": {
46-
title: "Call a tool in your IDE/MCP Client",
50+
learn: {
51+
title: <TitleWithIcon icon={Book}>Learn</TitleWithIcon>,
4752
},
48-
"custom-mcp-server-quickstart": {
49-
title: "Build MCP Server QuickStart",
50-
},
51-
"api-keys": {
52-
title: "Get an API key",
53-
},
54-
examples: {
55-
title: "Example agents",
56-
},
57-
"-- Authoring Tools": {
58-
type: "separator",
59-
title: "Authoring Tools",
60-
},
61-
"build-tools": {
62-
title: "Build tools",
63-
},
64-
"evaluate-tools": {
65-
title: "Evaluate tools",
66-
},
67-
"serve-tools": {
68-
title: "Serve tools",
69-
},
70-
"-- Agent Frameworks and MCP": {
71-
type: "separator",
72-
title: "Agent Frameworks and MCP",
73-
},
74-
"agent-frameworks-overview": {
75-
title: "Overview",
76-
},
77-
"mcp-clients": {
78-
title: "MCP Clients",
79-
},
80-
langchain: {
81-
title: "LangChain",
82-
},
83-
crewai: {
84-
title: "CrewAI",
85-
},
86-
"google-adk": {
87-
title: "Google ADK",
88-
},
89-
mastra: {
90-
title: "Mastra",
91-
},
92-
"oai-agents": {
93-
title: "OpenAI Agents",
94-
},
95-
vercelai: {
96-
title: "Vercel AI",
97-
},
98-
"-- Core Concepts": {
99-
type: "separator",
100-
title: "Core Concepts",
101-
},
102-
"use-tools": {
103-
title: "Tool Calling",
104-
},
105-
auth: {
106-
title: "Authorization",
107-
},
108-
"mcp-gateways": {
109-
title: "MCP Gateways",
110-
},
111-
"arcade-cli": {
112-
title: "Arcade CLI",
113-
},
114-
"-- Hosting options": {
115-
type: "separator",
116-
title: "Hosting options",
117-
},
118-
"hosting-overview": {
119-
title: "Overview",
120-
},
121-
deployment: {
122-
title: "Deployment",
123-
},
124-
"auth-providers": {
125-
title: "Customizing Auth",
126-
},
127-
"-- Guides": {
128-
type: "separator",
129-
title: "Guides",
130-
},
131-
glossary: {
132-
title: "Glossary",
133-
},
134-
faq: {
135-
title: "FAQ",
136-
},
137-
"compare-server-types": {
138-
title: "Compare Server Types",
139-
},
140-
"agentic-development": {
141-
title: "Agentic Development",
142-
},
143-
changelog: {
144-
title: "Changelog",
145-
},
146-
"-- Registry": {
147-
type: "separator",
148-
title: "Registry",
149-
},
150-
"registry-early-access": {
151-
title: "Registry Early Access",
152-
},
153-
"-- Resources": {
154-
type: "separator",
155-
title: "Resources",
156-
},
157-
"contact-us": {
158-
title: <TitleWithIcon icon={BadgeHelp}>Contact us</TitleWithIcon>,
159-
},
160-
security: {
161-
title: <TitleWithIcon icon={Shield}>Security</TitleWithIcon>,
53+
references: {
54+
title: <TitleWithIcon icon={GraduationCap}>References</TitleWithIcon>,
16255
},
16356
};
16457

app/en/get-started/_meta.tsx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import type { MetaRecord } from "nextra";
2+
3+
export const meta: MetaRecord = {
4+
"about-arcade": "About Arcade",
5+
setup: "Setup",
6+
quickstarts: "Quickstarts",
7+
};
8+
9+
export default meta;

app/en/get-started/about-arcade/page.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: "Learn how Arcade helps with auth and tool calling"
55

66
import { Tabs } from "nextra/components";
77

8+
# About Arcade
9+
810
Applications that use models to perform tasks (_agentic applications_) commonly require access to sensitive data and services. Authentication complexities often hinder AI from performing tasks that require user-specific information, like what emails you recently received or what's coming up on your calendar.
911

1012
To retrieve this information, agentic applications need to be able to authenticate and authorize access to external services you use like Gmail or Google Calendar.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import type { MetaRecord } from "nextra";
2+
3+
export const meta: MetaRecord = {
4+
"call-tool-agent": "Call tools in agents",
5+
"call-tool-client": "Call tools in IDE/MCP clients",
6+
"mcp-server-quickstart": "Build an MCP server for custom tools",
7+
};
8+
9+
export default meta;

0 commit comments

Comments
 (0)