-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: update docs home #948
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
827eb14
feat: add home page documentation and navigation updates
necatiozmen 64828e3
feat: enhance DocsHome layout and styling with full-width background …
necatiozmen 4bf842f
feat: update DocsHome layout and styling, enhance FeatureShowcase
necatiozmen f0762ad
feat: update tutorial link in DocsHome and adjust FeatureShowcase styles
necatiozmen ce728ec
feat: enhance navbar and DocsHome styling with updated icons and impr…
necatiozmen 7223308
feat: update sidebar link styles for improved readability and consist…
necatiozmen 93b30d3
docs: update website/src/components/feature-showcase/mock-data.ts
necatiozmen 4cb7e49
fix: correct spacing in footerText for improved readability
necatiozmen 20a0dee
Merge branch 'update-docs-home' of https://github.com/VoltAgent/volta…
necatiozmen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: Home | ||
| sidebar_label: Home | ||
| slug: /home | ||
| hide_table_of_contents: true | ||
| hide_title: true | ||
| custom_edit_url: null | ||
| --- | ||
|
|
||
| import DocsHome from '@site/src/components/docs-widgets/DocsHome'; | ||
|
|
||
| <DocsHome /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| import Link from "@docusaurus/Link"; | ||
| import { | ||
| BookOpenIcon, | ||
| CodeBracketIcon, | ||
| ListBulletIcon, | ||
| RocketLaunchIcon, | ||
| Squares2X2Icon, | ||
| } from "@heroicons/react/24/outline"; | ||
| // @ts-expect-error - Docusaurus theme component | ||
| import CodeBlock from "@theme/CodeBlock"; | ||
| import { FeatureShowcase } from "../feature-showcase"; | ||
| import { DotPattern } from "../ui/dot-pattern"; | ||
|
|
||
| const codeExample = `import { VoltAgent, Agent } from "@voltagent/core"; | ||
| import { honoServer } from "@voltagent/server-hono"; | ||
| import { openai } from "@ai-sdk/openai"; | ||
|
|
||
| const agent = new Agent({ | ||
| name: "my-voltagent-app", | ||
| instructions: "A helpful assistant that answers questions", | ||
| model: openai("gpt-4o-mini"), | ||
| }); | ||
|
|
||
| new VoltAgent({ | ||
| agents: { agent }, | ||
| server: honoServer(), | ||
| });`; | ||
|
|
||
| const coreFeatures = ["Memory", "RAG", "Guardrails", "Tools", "MCP", "Voice", "Workflow"]; | ||
|
|
||
| const quickLinks = [ | ||
| { | ||
| title: "Quick Start", | ||
| description: "Get up and running with VoltAgent in minutes.", | ||
| href: "/docs/quick-start/", | ||
| icon: RocketLaunchIcon, | ||
| }, | ||
|
|
||
| { | ||
| title: "Recipes & Guides", | ||
| description: "Ready-to-use patterns and best practices.", | ||
| href: "/recipes-and-guides/", | ||
| icon: BookOpenIcon, | ||
| }, | ||
|
|
||
| { | ||
| title: "5 Steps Tutorial", | ||
| description: "Learn the fundamentals with hands-on examples.", | ||
| href: "/tutorial/introduction/", | ||
| icon: ListBulletIcon, | ||
| }, | ||
| ]; | ||
|
|
||
| export default function DocsHome() { | ||
| return ( | ||
| <div className="docs-home -mt-8 max-w-7xl mx-auto md:px-4"> | ||
| <DotPattern dotColor="#94a3b8" dotSize={1.2} spacing={20} /> | ||
| {/* Hero Section - Centered */} | ||
| <div className="text-center pt-8 md:pt-16 pb-8 md:pb-12 mb-4 md:mb-8 overflow-visible"> | ||
| <div | ||
| className="text-2xl sm:text-3xl md:text-5xl lg:text-6xl font-semibold mb-4 md:mb-6 leading-normal pb-2" | ||
| style={{ | ||
| background: "linear-gradient(to right, #ffffff, #a1a1aa)", | ||
| WebkitBackgroundClip: "text", | ||
| WebkitTextFillColor: "transparent", | ||
| backgroundClip: "text", | ||
| lineHeight: 1.2, | ||
| }} | ||
| > | ||
| Build · Observe · Automate · Ship | ||
| <br /> | ||
| AI Agents | ||
| </div> | ||
| <div className="text-sm sm:text-base md:text-lg text-white max-w-xl mx-auto px-2"> | ||
| AI Agent Engineering Platform for <span className="text-[#b2b2b2]">development</span>,{" "} | ||
| <span className="text-[#b2b2b2]">observability</span>,{" "} | ||
| <span className="text-[#b2b2b2]">evaluation</span>, and{" "} | ||
| <span className="text-[#b2b2b2]">deployment</span> in one place. | ||
| </div> | ||
| </div> | ||
|
|
||
| {/* VoltAgent Core Section */} | ||
| <div className="mb-8 md:mb-12"> | ||
| <div className="flex flex-col sm:flex-row sm:items-center gap-2 sm:gap-3 mb-3"> | ||
| <div className="flex items-center gap-2"> | ||
| <CodeBracketIcon className="w-5 h-5 md:w-6 md:h-6 text-[#00d992]" /> | ||
| <span className="text-xl md:text-2xl font-semibold text-white">Core</span> | ||
| </div> | ||
| <span className="px-2 py-0.5 text-xs md:text-sm rounded-full bg-zinc-800/80 text-zinc-300 border border-zinc-700/50"> | ||
| Open Source TypeScript Framework | ||
| </span> | ||
| </div> | ||
| <p className="docs-home-description text-sm md:text-base mb-4 text-zinc-400"> | ||
| Everything you need to build production-ready AI agents in TypeScript. | ||
| </p> | ||
|
|
||
| {/* Feature Badges */} | ||
| <div className="flex flex-wrap gap-1.5 md:gap-2 mb-4 md:mb-6"> | ||
| {coreFeatures.map((feature) => ( | ||
| <span | ||
| key={feature} | ||
| className="px-2 md:px-3 py-0.5 md:py-1 text-xs md:text-sm rounded-full bg-zinc-800/50 text-zinc-300 border border-zinc-700/50" | ||
| > | ||
| {feature} | ||
| </span> | ||
| ))} | ||
| <span className="px-2 md:px-3 py-0.5 md:py-1 text-xs md:text-sm rounded-full bg-zinc-800/50 text-zinc-500 border border-zinc-700/50"> | ||
| and more... | ||
| </span> | ||
| </div> | ||
|
|
||
| {/* Code Block */} | ||
| <CodeBlock language="typescript">{codeExample}</CodeBlock> | ||
| </div> | ||
|
|
||
| {/* VoltOps Console Section */} | ||
| <div className="mb-8 md:mb-12 bg-black"> | ||
| <div className="flex flex-col sm:flex-row sm:items-center gap-2 sm:gap-3 mb-3"> | ||
| <div className="flex items-center gap-2"> | ||
| <Squares2X2Icon className="w-5 h-5 md:w-6 md:h-6 text-[#00d992]" /> | ||
| <span className="text-xl md:text-2xl font-semibold text-white">VoltOps Console</span> | ||
| </div> | ||
| <span className="px-2 py-0.5 text-xs md:text-sm rounded-full bg-zinc-800/80 text-zinc-300 border border-zinc-700/50"> | ||
| Cloud / Self-Hosted Platform | ||
| </span> | ||
| </div> | ||
| <p className="docs-home-description text-sm md:text-base mb-4 text-zinc-400"> | ||
| Enterprise-grade platform to take AI agents from development to production. | ||
| </p> | ||
| {/* Feature Showcase - Full Width */} | ||
| <div className="my-6 md:my-12 relative left-1/2 right-1/2 -ml-[50vw] -mr-[50vw] w-screen max-w-none px-2 md:px-8"> | ||
| <FeatureShowcase /> | ||
| </div> | ||
| {/* <div className="grid grid-cols-1 md:grid-cols-3 gap-4"> | ||
| {voltOpsFeatures.map((feature) => ( | ||
| <Link to={feature.href} className="no-underline hover:no-underline"> | ||
| <div | ||
| key={feature.title} | ||
| className="group p-5 cursor-pointer rounded-lg border border-solid border-zinc-800 hover:border-zinc-700 transition-all duration-200" | ||
| > | ||
| <div className="flex items-center gap-2 mb-2"> | ||
| <feature.icon className="w-5 h-5 text-[#00d992]" /> | ||
| <span className=" text-white">{feature.title}</span> | ||
| </div> | ||
|
|
||
| <p className="text-sm text-zinc-400 mb-4 leading-relaxed">{feature.description}</p> | ||
| <span className="inline-flex items-center gap-1 text-zinc-400 group-hover:text-white text-sm transition-all"> | ||
| Learn more <ArrowRightIcon className="w-3 h-3" /> | ||
| </span> | ||
| </div> | ||
| </Link> | ||
| ))} | ||
| </div> */} | ||
| </div> | ||
|
|
||
| {/* Quick Links Section */} | ||
| <div className="mb-8"> | ||
| <h2 className="text-lg md:text-xl font-semibold mb-3 md:mb-4 text-white">Get Started</h2> | ||
| <div className="grid grid-cols-1 sm:grid-cols-2 md:grid-cols-3 gap-3 md:gap-4"> | ||
| {quickLinks.map((link) => ( | ||
| <div | ||
| key={link.title} | ||
| className="group p-3 md:p-4 rounded-lg !border !border-solid !border-zinc-800 transition-all duration-200" | ||
| > | ||
| <div className="flex items-start gap-2 md:gap-3"> | ||
| <link.icon className="w-4 h-4 md:w-5 md:h-5 text-[#00d992] flex-shrink-0 mt-0.5" /> | ||
| <Link | ||
| to={link.href} | ||
| className="text-white font-medium hover:text-emerald-400 transition-colors no-underline hover:no-underline" | ||
| > | ||
| <div className="flex text-white flex-col"> | ||
| <span className="text-sm md:text-base">{link.title}</span> | ||
| <span className="text-[#b2b2b2] text-xs md:text-sm mt-1"> | ||
| {link.description} | ||
| </span> | ||
| </div> | ||
| </Link> | ||
| </div> | ||
| </div> | ||
| ))} | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
cat -n website/src/components/docs-widgets/DocsHome.tsx | head -150Repository: VoltAgent/voltagent
Length of output: 7228
🏁 Script executed:
rg -n "overflow-x|overflow:" website/src/components/docs-widgets/ -A 1Repository: VoltAgent/voltagent
Length of output: 386
🏁 Script executed:
fd -e css -e scss -e ts -e tsx website/ -x rg -l "overflow-x.*hidden|overflow.*hidden" {}Repository: VoltAgent/voltagent
Length of output: 400
🏁 Script executed:
Repository: VoltAgent/voltagent
Length of output: 6822
Full-width breakout technique may cause horizontal overflow.
The
left-1/2 right-1/2 -ml-[50vw] -mr-[50vw] w-screenpattern on line 131 can create horizontal scrollbars if overflow is not handled at the page or body level. Ensure the root layout or document body hasoverflow-x: hiddento prevent this UX issue.🤖 Prompt for AI Agents