From b962c80e4e3e9a64ab6e3fe25748dd5ae2d44030 Mon Sep 17 00:00:00 2001 From: bender Date: Sun, 8 Mar 2026 16:36:38 +0000 Subject: [PATCH] Update src/app/docs/page.tsx --- src/app/docs/page.tsx | 191 ++++++++++++------------------------------ 1 file changed, 52 insertions(+), 139 deletions(-) diff --git a/src/app/docs/page.tsx b/src/app/docs/page.tsx index aeae472..e2bb5ed 100644 --- a/src/app/docs/page.tsx +++ b/src/app/docs/page.tsx @@ -67,95 +67,54 @@ export default function DocsPage() { useInvertedBackground={false} features={[ { - title: "Installation & Setup", - description: - "Quick start guide for setting up AgentOS in your environment with all dependencies.", - bentoComponent: "timeline", - heading: "Setup Process", - subheading: "From Installation to First Agent", - items: [ + title: "Installation & Setup", description: + "Quick start guide for setting up AgentOS in your environment with all dependencies.", bentoComponent: "timeline", heading: "Setup Process", subheading: "From Installation to First Agent", items: [ { - label: "Install SDK", - detail: "pip install agentosxyz", - }, + label: "Install SDK", detail: "pip install agentosxyz"}, { - label: "Configure API Key", - detail: "Set environment variables", - }, + label: "Configure API Key", detail: "Set environment variables"}, { - label: "Deploy Agent", - detail: "Run your first agent", - }, + label: "Deploy Agent", detail: "Run your first agent"}, ], - completedLabel: "Complete", - }, + completedLabel: "Complete"}, { - title: "Core Concepts", - description: - "Understand ReAct loops, agent types, memory systems, and the reasoning engine.", - bentoComponent: "3d-stack-cards", - items: [ + title: "Core Concepts", description: + "Understand ReAct loops, agent types, memory systems, and the reasoning engine.", bentoComponent: "3d-stack-cards", items: [ { icon: Brain, - title: "Reasoning Loop", - subtitle: "ReAct Pattern", - detail: "Goal → Plan → Execute → Observe", - }, + title: "Reasoning Loop", subtitle: "ReAct Pattern", detail: "Goal → Plan → Execute → Observe"}, { icon: Database, - title: "Memory System", - subtitle: "Vector Embeddings", - detail: "Persistent knowledge storage", - }, + title: "Memory System", subtitle: "Vector Embeddings", detail: "Persistent knowledge storage"}, { icon: Zap, - title: "Tool Execution", - subtitle: "Dynamic Binding", - detail: "API integration framework", - }, + title: "Tool Execution", subtitle: "Dynamic Binding", detail: "API integration framework"}, ], }, { - title: "API Reference", - description: - "Complete REST API documentation with examples for all AgentOS endpoints.", - bentoComponent: "icon-info-cards", - items: [ + title: "API Reference", description: + "Complete REST API documentation with examples for all AgentOS endpoints.", bentoComponent: "icon-info-cards", items: [ { icon: Code, - label: "Agents Endpoint", - value: "/api/agents", - }, + label: "Agents Endpoint", value: "/api/agents"}, { icon: Database, - label: "Memory API", - value: "/api/memory", - }, + label: "Memory API", value: "/api/memory"}, { icon: GitBranch, - label: "Tools Endpoint", - value: "/api/tools", - }, + label: "Tools Endpoint", value: "/api/tools"}, { icon: BarChart, - label: "Metrics API", - value: "/api/metrics", - }, + label: "Metrics API", value: "/api/metrics"}, { icon: Shield, - label: "Auth Endpoint", - value: "/api/auth", - }, + label: "Auth Endpoint", value: "/api/auth"}, ], }, { - title: "Code Examples", - description: - "Practical examples in Python and TypeScript for common agent patterns.", - bentoComponent: "marquee", - centerIcon={Code, - variant: "icon", - icons: [ + title: "Code Examples", description: + "Practical examples in Python and TypeScript for common agent patterns.", bentoComponent: "marquee", centerIcon: Code, + variant: "icon", icons: [ CheckCircle, GitBranch, Database, @@ -165,11 +124,8 @@ export default function DocsPage() { ], }, { - title: "Deployment Guide", - description: - "Deploy AgentOS on Docker, Kubernetes, AWS, Google Cloud, and Azure.", - bentoComponent: "orbiting-icons", - centerIcon: Layers, + title: "Deployment Guide", description: + "Deploy AgentOS on Docker, Kubernetes, AWS, Google Cloud, and Azure.", bentoComponent: "orbiting-icons", centerIcon: Layers, items: [ { icon: Globe, ring: 1 }, { icon: Shield, ring: 1 }, @@ -178,11 +134,8 @@ export default function DocsPage() { ], }, { - title: "SDK Reference", - description: - "Complete SDK documentation for Python and TypeScript with type definitions.", - bentoComponent: "animated-bar-chart", - }, + title: "SDK Reference", description: + "Complete SDK documentation for Python and TypeScript with type definitions.", bentoComponent: "animated-bar-chart"}, ]} /> @@ -199,65 +152,35 @@ export default function DocsPage() { useInvertedBackground={true} faqs={[ { - id: "1", - title: "How do I create my first agent?", - content: - "Install the SDK with `pip install agentosxyz`, then use AgentOS.create_agent() with your desired configuration. See our Getting Started guide for a complete example.", - }, + id: "1", title: "How do I create my first agent?", content: + "Install the SDK with `pip install agentosxyz`, then use AgentOS.create_agent() with your desired configuration. See our Getting Started guide for a complete example."}, { - id: "2", - title: "What programming languages are supported?", - content: - "AgentOS provides official SDKs for Python and TypeScript. The REST API works with any programming language that supports HTTP requests.", - }, + id: "2", title: "What programming languages are supported?", content: + "AgentOS provides official SDKs for Python and TypeScript. The REST API works with any programming language that supports HTTP requests."}, { - id: "3", - title: "How do I integrate custom tools?", - content: - "Use the Tool Registry API to register custom tools. Provide a function definition, input schema, and output format. AgentOS handles the rest.", - }, + id: "3", title: "How do I integrate custom tools?", content: + "Use the Tool Registry API to register custom tools. Provide a function definition, input schema, and output format. AgentOS handles the rest."}, { - id: "4", - title: "Can I use multiple LLM providers?", - content: - "Yes. AgentOS abstracts LLM providers through a unified interface. Switch between OpenAI, Claude, Llama, and others without code changes.", - }, + id: "4", title: "Can I use multiple LLM providers?", content: + "Yes. AgentOS abstracts LLM providers through a unified interface. Switch between OpenAI, Claude, Llama, and others without code changes."}, { - id: "5", - title: "How do I monitor agent performance?", - content: - "Use the Metrics API (/api/metrics) to retrieve agent performance data, task completion rates, and system health. The dashboard provides real-time visualization.", - }, + id: "5", title: "How do I monitor agent performance?", content: + "Use the Metrics API (/api/metrics) to retrieve agent performance data, task completion rates, and system health. The dashboard provides real-time visualization."}, { - id: "6", - title: "What's the maximum number of agents I can run?", - content: - "Depends on your plan. Starter: 3 agents, Professional: 20 agents, Enterprise: unlimited. Professional and Enterprise plans include auto-scaling.", - }, + id: "6", title: "What's the maximum number of agents I can run?", content: + "Depends on your plan. Starter: 3 agents, Professional: 20 agents, Enterprise: unlimited. Professional and Enterprise plans include auto-scaling."}, { - id: "7", - title: "How is authentication handled?", - content: - "AgentOS uses API keys for authentication. Include your API key in the Authorization header of all requests. Keys can be generated in your dashboard.", - }, + id: "7", title: "How is authentication handled?", content: + "AgentOS uses API keys for authentication. Include your API key in the Authorization header of all requests. Keys can be generated in your dashboard."}, { - id: "8", - title: "What's the rate limit for API calls?", - content: - "Rate limits depend on your plan. Starter: 1M requests/month, Professional: 10M requests/month, Enterprise: unlimited. Requests are counted per 24-hour window.", - }, + id: "8", title: "What's the rate limit for API calls?", content: + "Rate limits depend on your plan. Starter: 1M requests/month, Professional: 10M requests/month, Enterprise: unlimited. Requests are counted per 24-hour window."}, { - id: "9", - title: "How do I debug agent behavior?", - content: - "Enable debug logging to see detailed reasoning traces. Use the Logs API (/api/logs) to retrieve comprehensive execution logs for troubleshooting.", - }, + id: "9", title: "How do I debug agent behavior?", content: + "Enable debug logging to see detailed reasoning traces. Use the Logs API (/api/logs) to retrieve comprehensive execution logs for troubleshooting."}, { - id: "10", - title: "Can I export agent configurations?", - content: - "Yes. Use the Export API to download agent definitions, tool configurations, and settings in JSON format for version control and sharing.", - }, + id: "10", title: "Can I export agent configurations?", content: + "Yes. Use the Export API to download agent definitions, tool configurations, and settings in JSON format for version control and sharing."}, ]} /> @@ -271,13 +194,9 @@ export default function DocsPage() { description="Browse our comprehensive documentation, join the community Slack, or schedule a support call with our engineering team." buttons={[ { - text: "Visit Support Portal", - href: "https://support.example.com", - }, + text: "Visit Support Portal", href: "https://support.example.com"}, { - text: "Join Community", - href: "https://community.example.com", - }, + text: "Join Community", href: "https://community.example.com"}, ]} buttonAnimation="slide-up" background={{ variant: "radial-gradient" }} @@ -290,8 +209,7 @@ export default function DocsPage() { logoText="AgentOS" columns={[ { - title: "Platform", - items: [ + title: "Platform", items: [ { label: "Features", href: "#features" }, { label: "Architecture", href: "#about" }, { label: "Pricing", href: "/pricing" }, @@ -299,8 +217,7 @@ export default function DocsPage() { ], }, { - title: "Company", - items: [ + title: "Company", items: [ { label: "About", href: "https://example.com/about" }, { label: "Blog", href: "https://blog.example.com" }, { label: "Careers", href: "https://careers.example.com" }, @@ -308,20 +225,16 @@ export default function DocsPage() { ], }, { - title: "Resources", - items: [ + title: "Resources", items: [ { label: "API Reference", href: "https://docs.example.com/api" }, { - label: "Tutorials", - href: "https://docs.example.com/tutorials", - }, + label: "Tutorials", href: "https://docs.example.com/tutorials"}, { label: "SDK", href: "https://github.com/agentosxyz" }, { label: "Community", href: "https://community.example.com" }, ], }, { - title: "Legal", - items: [ + title: "Legal", items: [ { label: "Privacy Policy", href: "#" }, { label: "Terms of Service", href: "#" }, { label: "Security", href: "https://security.example.com" }, -- 2.49.1