From 075cadcc0002230c384e275a0a1601aafd5c0f40 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Thu, 10 Jul 2025 19:42:44 +0000 Subject: [PATCH] feat: add JSON-LD schema markup and enhanced metadata for LLM SEO - Add TechArticle, Website, and BreadcrumbList schema markup to docs layout - Add FAQ schema to what-is-an-agent.mdx with common AI agent questions - Add HowTo schema to getting-started.mdx with step-by-step guide - Enhance meta descriptions with more context-rich content - Expand keywords to include AI agents and cloud deployment terms - Improve LLM understanding and discoverability per Vercel's recommendations Co-Authored-By: Rick Blalock --- app/layout.tsx | 169 +++++++++++++++++++++-- content/Guides/what-is-an-agent.mdx | 61 +++++++- content/Introduction/getting-started.mdx | 112 ++++++++++++++- 3 files changed, 325 insertions(+), 17 deletions(-) diff --git a/app/layout.tsx b/app/layout.tsx index e5f79926..d937c6b1 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -3,6 +3,7 @@ import { GeistSans } from "geist/font/sans"; import type { ReactNode } from "react"; import type { Metadata } from 'next'; import { validateEnv } from "@/lib/env"; +import Script from 'next/script'; import "./global.css"; // Validate environment variables at startup (server-side only) @@ -12,18 +13,32 @@ if (typeof window === 'undefined') { export const metadata: Metadata = { metadataBase: new URL('https://www.agentuity.dev'), - title: 'Agentuity Docs', + title: 'Agentuity Documentation — Complete guide to AI agent deployment', description: - 'Documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents.', + 'Comprehensive documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents. Learn how to build, deploy, and manage autonomous agents with our CLI, SDKs, and cloud infrastructure.', applicationName: 'Agentuity Docs', authors: [{ name: 'Agentuity, Inc.' }], keywords: [ - 'AI', - 'Agents', - 'Cloud Platform', - 'Deployment', - 'Management', - 'Scaling', + 'AI agents documentation', + 'artificial intelligence', + 'cloud platform', + 'agent deployment guide', + 'AI infrastructure', + 'autonomous agents', + 'LangChain integration', + 'CrewAI integration', + 'agent management', + 'AI scaling', + 'machine learning operations', + 'MLOps', + 'agent orchestration', + 'AI automation', + 'intelligent agents', + 'API documentation', + 'SDK documentation', + 'CLI documentation', + 'tutorials', + 'examples', ], referrer: 'origin-when-cross-origin', creator: 'Agentuity, Inc.', @@ -49,9 +64,9 @@ export const metadata: Metadata = { }, manifest: '/manifest.json', openGraph: { - title: 'Agentuity Docs', + title: 'Agentuity Documentation — Complete guide to AI agent deployment', description: - 'Documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents.', + 'Comprehensive documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents. Learn how to build, deploy, and manage autonomous agents.', url: 'https://www.agentuity.dev', siteName: 'Agentuity Docs', images: [ @@ -59,7 +74,7 @@ export const metadata: Metadata = { url: '/og-image.png', width: 1200, height: 630, - alt: 'Agentuity Docs', + alt: 'Agentuity Documentation - Complete guide to AI agent deployment and management', }, ], locale: 'en_US', @@ -69,9 +84,9 @@ export const metadata: Metadata = { card: 'summary_large_image', site: '@agentuity', creator: '@agentuity', - title: 'Agentuity Docs', + title: 'Agentuity Documentation — Complete guide to AI agent deployment', description: - 'Documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents.', + 'Comprehensive documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents. Learn how to build, deploy, and manage autonomous agents.', images: ['/og-image.png'], }, appleWebApp: { @@ -79,7 +94,7 @@ export const metadata: Metadata = { title: 'Agentuity Docs', statusBarStyle: 'black-translucent', }, - abstract: 'Documentation for Agentuity, the cloud platform purpose-built for deploying, managing, and scaling AI agents.', + abstract: 'Comprehensive technical documentation for Agentuity\'s AI agent cloud platform, including API references, SDK guides, CLI documentation, tutorials, and examples for building and deploying autonomous agents', category: 'technology', classification: 'Business Software', }; @@ -87,6 +102,132 @@ export const metadata: Metadata = { export default function Layout({ children }: { children: ReactNode }) { return ( + + + + + + {` + { + "@context": "https://schema.org", + "@type": "FAQPage", + "mainEntity": [ + { + "@type": "Question", + "name": "What is an AI agent?", + "acceptedAnswer": { + "@type": "Answer", + "text": "An AI agent is more like a smart assistant that can reason, plan, and act independently. Unlike APIs that just respond to commands, agents understand goals, adapt to changing conditions, and decide what to do next based on context. They don't just respond to commands; they can proactively get things done." + } + }, + { + "@type": "Question", + "name": "How are agents different from APIs?", + "acceptedAnswer": { + "@type": "Answer", + "text": "APIs are like vending machines — you make a specific request, and they return exactly what you asked for. They're passive and require constant human coordination. Agents are autonomous actors that can decide how to achieve a goal, operate continuously, respond to changing context, and coordinate complex tasks without being told every step." + } + }, + { + "@type": "Question", + "name": "Why isn't a traditional chatbot an AI agent?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A traditional chatbot is like a scripted receptionist — it follows predefined rules, matches keywords, and responds with canned answers. An AI agent is more like a smart collaborator that can interpret intent, reason through complex tasks, take independent actions, and adapt in real time. A chatbot talks; an agent thinks and acts." + } + }, + { + "@type": "Question", + "name": "What makes building agents different from traditional development?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Traditional development is logic-driven where every behavior is explicitly programmed. Agent development is intent-driven — you use natural language prompts to guide behavior, and the agent interprets these prompts and autonomously figures out what to do. This allows you to build flexible systems with far less code and far more adaptability." + } + }, + { + "@type": "Question", + "name": "Why do agents need an agent-native cloud?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Traditional cloud computing is optimized for low latency and sessionless architectures. Agents demand a new paradigm — they focus on long-running, complex tasks that require context and coordination. They are stateful and require both short and long term memory. They need to be centralized, often close to data resources or high-bandwidth GPU clusters." + } + } + ] + } + `} + + > But aren't agents just smart chat bots? 🤖 ## Understanding the Difference Between an API and an Agent @@ -74,4 +131,4 @@ Learn more details about the differences in today's cloud computing paradigm and ---- -If you're a software engineer and you need to build agents, you need to think like an [Agent Builder](/Guides/agent-engineering). \ No newline at end of file +If you're a software engineer and you need to build agents, you need to think like an [Agent Builder](/Guides/agent-engineering). diff --git a/content/Introduction/getting-started.mdx b/content/Introduction/getting-started.mdx index ebf4d997..b779f2c6 100644 --- a/content/Introduction/getting-started.mdx +++ b/content/Introduction/getting-started.mdx @@ -1,9 +1,119 @@ --- title: Getting Started -description: Get started with Agentuity in minutes +description: Get started with Agentuity in minutes - Learn how to deploy AI agents to the cloud with our step-by-step guide --- import { Step, Steps } from 'fumadocs-ui/components/steps'; +import Script from 'next/script'; + +