feat: add docs routes and layout

This commit is contained in:
codebanditssss 2026-06-03 22:12:25 +05:30
parent b3ed10a5ae
commit a8b5b6cf02
5 changed files with 827 additions and 0 deletions

View File

@ -0,0 +1,15 @@
import type { Metadata } from "next";
import { DocsMissingPage } from "@/components/docs/DocsMissingPage";
export const metadata: Metadata = {
title: "Docs page not found",
description: "This docs page moved or does not exist.",
robots: {
index: false,
follow: true,
},
};
export default function Docs404Page() {
return <DocsMissingPage />;
}

View File

@ -0,0 +1,85 @@
import { notFound } from "next/navigation";
import {
DocsPage,
DocsBody,
DocsTitle,
DocsDescription,
} from "fumadocs-ui/page";
import type { Metadata } from "next";
import { source } from "@/lib/source";
import { getMDXComponents } from "@/components/docs/mdx-components";
interface PageProps {
params: Promise<{ slug?: string[] }>;
}
export default async function DocsSlugPage({ params }: PageProps) {
const { slug } = await params;
const page = source.getPage(slug);
if (!page) notFound();
const MDX = page.data.body;
return (
<DocsPage
toc={page.data.toc}
full={page.data.full}
tableOfContent={{
style: "clerk",
single: false,
}}
editOnGithub={{
owner: "ComposioHQ",
repo: "agent-orchestrator",
sha: "main",
path: `website/content/docs/${page.file?.path ?? ""}`,
}}
breadcrumb={{
enabled: true,
includePage: true,
}}
footer={{
enabled: true,
}}
>
<DocsTitle>{page.data.title}</DocsTitle>
<DocsDescription>{page.data.description}</DocsDescription>
<DocsBody>
<MDX components={getMDXComponents()} />
</DocsBody>
</DocsPage>
);
}
export async function generateStaticParams() {
return source.generateParams();
}
export async function generateMetadata({
params,
}: PageProps): Promise<Metadata> {
const { slug } = await params;
const page = source.getPage(slug);
if (!page) {
return {
title: "Docs page not found",
description: "This docs page moved or does not exist.",
robots: {
index: false,
follow: true,
},
};
}
return {
title: page.data.title,
description: page.data.description,
alternates: {
canonical: `https://aoagents.dev${page.url}`,
},
openGraph: {
title: page.data.title,
description: page.data.description,
},
};
}

View File

@ -0,0 +1,593 @@
/*
* AO Warm Terminal theme for Fumadocs
* ====================================
* CRITICAL: Fumadocs Tailwind utilities use --color-fd-* variables (NOT --fd-*).
* We must override --color-fd-* to change colors. These are inside layer(fumadocs),
* so our unlayered :root overrides win.
*/
@import "fumadocs-ui/style.css" layer(fumadocs);
/*
1. COLOR OVERRIDES override --color-fd-* with AO design tokens
*/
:root {
/* Docs primary accent = AMBER (matches dashboard Orchestrator button + active items) */
--docs-accent: var(--color-accent-amber);
--docs-accent-dim: var(--color-accent-amber-dim);
--docs-accent-border: var(--color-accent-amber-border);
--color-fd-background: var(--color-bg-base);
--color-fd-foreground: var(--color-text-primary);
--color-fd-muted: var(--color-bg-elevated);
--color-fd-muted-foreground: var(--color-text-secondary);
--color-fd-popover: var(--color-bg-elevated);
--color-fd-popover-foreground: var(--color-text-primary);
--color-fd-card: var(--color-bg-surface);
--color-fd-card-foreground: var(--color-text-primary);
--color-fd-border: var(--color-border-default);
--color-fd-primary: var(--docs-accent);
--color-fd-primary-foreground: #ffffff;
--color-fd-secondary: var(--color-bg-elevated);
--color-fd-secondary-foreground: var(--color-text-primary);
--color-fd-accent: var(--docs-accent-dim);
--color-fd-accent-foreground: var(--docs-accent);
--color-fd-ring: var(--docs-accent);
}
.dark {
--docs-accent: var(--color-accent-amber);
--docs-accent-dim: var(--color-accent-amber-dim);
--docs-accent-border: var(--color-accent-amber-border);
--color-fd-background: var(--color-bg-base);
--color-fd-foreground: var(--color-text-primary);
--color-fd-muted: var(--color-bg-surface);
--color-fd-muted-foreground: var(--color-text-secondary);
--color-fd-popover: var(--color-bg-elevated);
--color-fd-popover-foreground: var(--color-text-primary);
--color-fd-card: var(--color-bg-surface);
--color-fd-card-foreground: var(--color-text-primary);
--color-fd-border: var(--color-border-default);
--color-fd-primary: var(--docs-accent);
--color-fd-primary-foreground: var(--color-bg-base);
--color-fd-secondary: var(--color-bg-elevated);
--color-fd-secondary-foreground: var(--color-text-primary);
--color-fd-accent: var(--docs-accent-dim);
--color-fd-accent-foreground: var(--docs-accent);
--color-fd-ring: var(--docs-accent);
}
/* Sidebar-specific dark overrides */
.dark #nd-sidebar {
--color-fd-muted: var(--color-bg-surface);
--color-fd-secondary: var(--color-bg-elevated);
--color-fd-muted-foreground: var(--color-text-secondary);
}
/* Sidebar background — match dashboard's very dark sidebar */
#nd-sidebar {
background-color: var(--color-bg-sidebar) !important;
border-right-color: var(--color-border-subtle) !important;
}
/*
1b. FLAT BACKGROUND kill the body gradient on docs pages
*/
#nd-docs-layout {
background: var(--color-bg-base) !important;
}
/*
1c. SEMANTIC COLORS override fumadocs info/warning/error colors to amber
*/
:root {
--color-fd-info: var(--docs-accent);
--color-fd-warning: var(--color-accent-amber);
--color-fd-success: #16a34a;
--color-fd-error: #dc2626;
}
.dark {
--color-fd-info: var(--docs-accent);
--color-fd-warning: var(--color-accent-amber);
--color-fd-success: #22c55e;
--color-fd-error: #ef4444;
}
/*
1c. FORCE WARM LINK COLORS fumadocs uses text-fd-primary (accent blue)
on too many elements. Override sidebar, TOC, and breadcrumb links
to warm gray. Only prose body links stay accent.
*/
/* Sidebar links: warm stone gray, not periwinkle (desktop + mobile) */
#nd-sidebar a:not([data-active="true"]),
#nd-sidebar button,
#nd-sidebar-mobile a:not([data-active="true"]),
#nd-sidebar-mobile button {
color: var(--color-text-secondary) !important;
}
#nd-sidebar a:not([data-active="true"]):hover,
#nd-sidebar button:hover,
#nd-sidebar-mobile a:not([data-active="true"]):hover,
#nd-sidebar-mobile button:hover {
color: var(--color-text-primary) !important;
}
/* Sidebar active link: amber accent (desktop + mobile) */
#nd-sidebar a[data-active="true"],
#nd-sidebar-mobile a[data-active="true"] {
color: var(--docs-accent) !important;
}
/* TOC links: warm gray, not blue */
#nd-toc a,
#nd-tocnav a {
color: var(--color-text-secondary) !important;
}
#nd-toc a:hover,
#nd-tocnav a:hover {
color: var(--color-text-primary) !important;
}
#nd-toc a[data-active="true"],
#nd-tocnav a[data-active="true"] {
color: var(--docs-accent) !important;
}
/* Breadcrumb: warm gray */
#nd-page nav a,
#nd-page [aria-label="breadcrumb"] a {
color: var(--color-text-secondary) !important;
text-decoration: none !important;
}
#nd-page nav a:hover,
#nd-page [aria-label="breadcrumb"] a:hover {
color: var(--color-text-primary) !important;
}
/* Page title breadcrumb link (the blue "Installation" at top) */
#nd-page a[href^="/docs"] {
color: var(--color-text-secondary) !important;
}
#nd-page a[href^="/docs"]:hover {
color: var(--color-text-primary) !important;
}
/* Step number circles: amber */
#nd-docs-layout .fd-step::before {
background: var(--docs-accent) !important;
}
/* Footer prev/next: warm gray, not blue */
#nd-page footer a,
#nd-page [class*="footer"] a {
color: var(--color-text-secondary) !important;
border-color: var(--color-border-default) !important;
}
#nd-page footer a:hover,
#nd-page [class*="footer"] a:hover {
color: var(--color-text-primary) !important;
border-color: var(--docs-accent) !important;
}
/*
2. TYPOGRAPHY Geist 13px body, JetBrains Mono code (dashboard match)
*/
#nd-docs-layout {
font-family:
var(--font-geist-sans),
ui-sans-serif,
system-ui,
-apple-system,
sans-serif;
font-size: 13px;
letter-spacing: -0.011em;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
#nd-docs-layout code,
#nd-docs-layout kbd,
#nd-docs-layout pre {
font-family:
var(--font-jetbrains-mono),
ui-monospace,
"SFMono-Regular",
monospace;
}
/* Sidebar — smaller text like dashboard */
#nd-sidebar {
font-size: 12.5px;
}
/* TOC — compact */
#nd-toc,
#nd-tocnav {
font-size: 11.5px;
}
/*
3. PROSE headings, links, tables, inline code
*/
#nd-docs-layout .prose h1 {
color: var(--color-text-primary);
font-weight: 700;
font-size: 1.65em;
letter-spacing: -0.02em;
}
#nd-docs-layout .prose h2 {
color: var(--color-text-primary);
font-weight: 680;
font-size: 1.3em;
letter-spacing: -0.015em;
}
#nd-docs-layout .prose h3 {
color: var(--color-text-primary);
font-weight: 640;
font-size: 1.1em;
}
#nd-docs-layout .prose h4 {
color: var(--color-text-primary);
font-weight: 620;
}
/* Heading anchors — strip card border/bg */
#nd-docs-layout .prose h1 a[data-card],
#nd-docs-layout .prose h2 a[data-card],
#nd-docs-layout .prose h3 a[data-card],
#nd-docs-layout .prose h4 a[data-card] {
border: none;
background: none;
padding: 0;
color: inherit;
}
/* Links — amber accent like dashboard */
#nd-docs-layout .prose a {
color: var(--docs-accent);
text-decoration: none;
}
#nd-docs-layout .prose a:hover {
text-decoration: underline;
text-underline-offset: 3px;
}
/* Tables — dashboard style: uppercase headers, dense */
#nd-docs-layout .prose table {
font-size: 12.5px;
}
#nd-docs-layout .prose th {
background-color: var(--color-bg-subtle);
color: var(--color-text-tertiary, var(--color-text-secondary));
font-size: 10px;
font-weight: 600;
letter-spacing: 0.06em;
text-transform: uppercase;
padding: 0.5rem 0.75rem;
}
#nd-docs-layout .prose td {
padding: 0.5rem 0.75rem;
}
/* Inline code */
#nd-docs-layout :not(pre) > code {
font-size: 0.85em;
padding: 0.12em 0.4em;
border-radius: 4px;
background-color: var(--color-bg-subtle);
border: 1px solid var(--color-border-subtle);
color: var(--docs-accent);
font-weight: 450;
}
/* No underlines in sidebar (desktop + mobile), TOC, or nav */
#nd-sidebar a,
#nd-sidebar button,
#nd-sidebar-mobile a,
#nd-sidebar-mobile button,
#nd-toc a,
#nd-tocnav a,
#nd-page nav a {
text-decoration: none !important;
}
/*
4. CODE BLOCKS Shiki, single border, copy button
*/
.shiki span {
color: var(--shiki-light) !important;
background-color: transparent !important;
}
.dark .shiki span {
color: var(--shiki-dark) !important;
background-color: transparent !important;
}
#nd-docs-layout pre,
pre.shiki,
pre.shiki code {
background-color: var(--color-bg-inset, var(--color-bg-surface)) !important;
}
#nd-docs-layout pre {
font-size: 12px;
line-height: 1.7;
overflow-x: auto;
tab-size: 2;
}
#nd-docs-layout pre:not(figure *) {
border-radius: 6px;
border: 1px solid var(--color-border-subtle);
padding: 0.875rem 1rem;
}
#nd-docs-layout figure pre {
border: none;
border-radius: 0;
margin: 0;
}
#nd-docs-layout figure.shiki {
background-color: var(--color-bg-inset, var(--color-bg-surface)) !important;
border-color: var(--color-border-subtle) !important;
border-radius: 6px;
}
/* Copy button fade on hover */
#nd-docs-layout figure[data-rehype-pretty-code-figure] button,
#nd-docs-layout [data-rehype-pretty-code-figure] button[aria-label] {
opacity: 0;
transition: opacity 0.15s ease;
}
#nd-docs-layout figure[data-rehype-pretty-code-figure]:hover button,
#nd-docs-layout [data-rehype-pretty-code-figure]:hover button[aria-label] {
opacity: 1;
}
/*
5. CALLOUTS
*/
#nd-docs-layout [data-callout] {
border-radius: 6px;
border-left-width: 3px;
padding: 0.625rem 0.875rem;
margin: 1.25rem 0;
font-size: 12.5px;
}
/* Force info callout to amber (fumadocs uses --color-fd-info internally) */
#nd-docs-layout [data-callout][data-type="info"] {
--callout-color: var(--docs-accent) !important;
}
/* Edit on GitHub button — force amber colors */
#nd-docs-layout a[href*="github.com"][href*="/blob/"] {
color: var(--color-text-secondary) !important;
}
#nd-docs-layout a[href*="github.com"][href*="/blob/"]:hover {
color: var(--docs-accent) !important;
}
/*
6. SCROLLBAR
*/
#nd-docs-layout pre::-webkit-scrollbar {
height: 4px;
}
#nd-docs-layout pre::-webkit-scrollbar-track {
background: transparent;
}
#nd-docs-layout pre::-webkit-scrollbar-thumb {
background: var(--color-scrollbar, rgba(255, 240, 220, 0.15));
border-radius: 2px;
}
/*
7. SEARCH MODAL
*/
[data-search-dialog] {
--color-fd-background: var(--color-bg-elevated);
--color-fd-border: var(--color-border-default);
--color-fd-card: var(--color-bg-surface);
}
/*
8. DENSITY tighter spacing to match dashboard
*/
#nd-docs-layout .prose > * + * {
margin-top: 1em;
}
#nd-docs-layout .prose > h2 {
margin-top: 2em;
}
#nd-docs-layout .prose > h3 {
margin-top: 1.5em;
}
/*
9. DOCS 404
*/
#nd-docs-layout .docs-missing-wrap {
display: flex;
min-height: calc(100vh - var(--fd-nav-height, 0px) - 8rem);
align-items: center;
padding-block: 2rem;
}
#nd-docs-layout .docs-missing-card {
width: 100%;
max-width: 56rem;
margin-inline: auto;
overflow: hidden;
border: 1px solid var(--color-border-default);
border-radius: 8px;
background: var(--color-bg-surface);
}
#nd-docs-layout .docs-missing-label {
padding: 0.75rem 1.5rem;
border-bottom: 1px solid var(--color-border-subtle);
background: var(--color-bg-inset);
color: var(--color-accent-amber);
font-family: var(--font-mono);
font-size: 0.6875rem;
font-weight: 600;
letter-spacing: 0.22em;
text-transform: uppercase;
}
#nd-docs-layout .docs-missing-content {
display: grid;
grid-template-columns: minmax(0, 1fr) 15rem;
gap: 1.5rem;
align-items: start;
padding: 1.5rem;
}
#nd-docs-layout .docs-missing-copy h2 {
max-width: 42rem;
margin: 0;
color: var(--color-text-primary);
font-size: 1.875rem;
font-weight: 650;
line-height: 1.15;
letter-spacing: 0;
}
#nd-docs-layout .docs-missing-copy p {
max-width: 42rem;
margin: 0.75rem 0 0;
color: var(--color-text-secondary);
font-size: 0.875rem;
line-height: 1.65;
}
#nd-docs-layout .docs-missing-actions {
display: flex;
flex-wrap: wrap;
gap: 0.75rem;
margin-top: 1.5rem;
}
#nd-docs-layout .docs-missing-primary,
#nd-docs-layout .docs-missing-secondary {
display: inline-flex;
height: 2.5rem;
align-items: center;
justify-content: center;
border-radius: 6px;
padding: 0 1rem;
font-size: 0.875rem;
font-weight: 600;
text-decoration: none;
transition: border-color 0.15s ease, color 0.15s ease, opacity 0.15s ease;
}
#nd-docs-layout .docs-missing-primary {
background: var(--color-accent-amber);
color: #1a1918;
}
#nd-docs-layout .docs-missing-primary:hover {
opacity: 0.9;
}
#nd-docs-layout .docs-missing-secondary {
border: 1px solid var(--color-border-default);
color: var(--color-text-secondary);
}
#nd-docs-layout .docs-missing-secondary:hover {
color: var(--color-text-primary);
}
#nd-docs-layout .docs-missing-terminal {
min-width: 0;
padding: 1rem;
border: 1px solid var(--color-border-subtle);
border-radius: 6px;
background: var(--color-bg-inset);
color: var(--color-text-secondary);
font-family: var(--font-mono);
font-size: 0.75rem;
line-height: 1.6;
}
#nd-docs-layout .docs-missing-terminal p {
margin: 0;
}
#nd-docs-layout .docs-missing-terminal p + p {
margin-top: 0.375rem;
}
#nd-docs-layout .docs-missing-dots {
display: flex;
gap: 0.375rem;
margin-bottom: 0.75rem;
}
#nd-docs-layout .docs-missing-dots span {
width: 0.5rem;
height: 0.5rem;
border-radius: 999px;
}
#nd-docs-layout .docs-missing-dot-red {
background: #ef4444;
}
#nd-docs-layout .docs-missing-dot-yellow {
background: #f59e0b;
}
#nd-docs-layout .docs-missing-dot-green {
background: #22c55e;
}
#nd-docs-layout .docs-missing-command {
color: var(--color-text-tertiary);
}
#nd-docs-layout .docs-missing-status {
color: var(--color-text-primary);
font-weight: 600;
}
@media (max-width: 900px) {
#nd-docs-layout .docs-missing-content {
grid-template-columns: 1fr;
}
}

View File

@ -0,0 +1,129 @@
import type { ReactNode } from "react";
import { DocsLayout } from "fumadocs-ui/layouts/docs";
import { RootProvider } from "fumadocs-ui/provider";
import type { LinkItemType } from "fumadocs-ui/layouts/shared";
import { source } from "@/lib/source";
import "./docs.css";
function GithubIcon({ size = 16 }: { size?: number } = {}) {
return (
<svg width={size} height={size} viewBox="0 0 24 24" fill="currentColor">
<path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z" />
</svg>
);
}
function XIcon() {
return (
<svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor">
<path d="M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z" />
</svg>
);
}
function DiscordIcon() {
return (
<svg width="18" height="18" viewBox="0 0 24 24" fill="currentColor">
<path d="M20.317 4.37a19.791 19.791 0 0 0-4.885-1.515.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 0 0-5.487 0 12.64 12.64 0 0 0-.617-1.25.077.077 0 0 0-.079-.037A19.736 19.736 0 0 0 3.677 4.37a.07.07 0 0 0-.032.027C.533 9.046-.32 13.58.099 18.057a.082.082 0 0 0 .031.057 19.9 19.9 0 0 0 5.993 3.03.078.078 0 0 0 .084-.028 14.09 14.09 0 0 0 1.226-1.994.076.076 0 0 0-.041-.106 13.107 13.107 0 0 1-1.872-.892.077.077 0 0 1-.008-.128 10.2 10.2 0 0 0 .372-.292.074.074 0 0 1 .077-.01c3.928 1.793 8.18 1.793 12.062 0a.074.074 0 0 1 .078.01c.12.098.246.198.373.292a.077.077 0 0 1-.006.127 12.299 12.299 0 0 1-1.873.892.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 0 0 .084.028 19.839 19.839 0 0 0 6.002-3.03.077.077 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 0 0-.031-.03zM8.02 15.33c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.956-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.956 2.418-2.157 2.418zm7.975 0c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.955-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.946 2.418-2.157 2.418z" />
</svg>
);
}
const links: LinkItemType[] = [
{
type: "icon",
label: "X (Twitter)",
icon: <XIcon />,
text: "X",
url: "https://x.com/aoagents",
external: true,
},
{
type: "icon",
label: "Discord",
icon: <DiscordIcon />,
text: "Discord",
url: "https://discord.gg/UZv7JjxbwG",
external: true,
},
];
async function GitHubStars() {
let stars: string | null = null;
try {
const res = await fetch(
"https://api.github.com/repos/ComposioHQ/agent-orchestrator",
{ next: { revalidate: 3600 } },
);
if (res.ok) {
const data = await res.json();
const count = data.stargazers_count as number;
stars = count >= 1000 ? `${(count / 1000).toFixed(1)}K` : String(count);
}
} catch {
/* GitHub API failed — hide stars */
}
return stars ? (
<span className="inline-flex items-center gap-1 text-[var(--color-text-muted)]">
<svg
width="12"
height="12"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
strokeWidth="2"
>
<polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2" />
</svg>
{stars}
</span>
) : null;
}
export default function Layout({ children }: { children: ReactNode }) {
return (
<RootProvider
theme={{ enabled: true, defaultTheme: "dark" }}
search={{ options: { type: "static" } }}
>
<DocsLayout
tree={source.pageTree}
links={links}
nav={{
title: (
<span className="flex items-center gap-2 font-semibold">
<img
src="/ao-logo.svg"
alt=""
aria-hidden="true"
width={22}
height={22}
className="h-[22px] w-[22px]"
/>
<span className="text-[var(--color-text-primary)]">AO</span>
</span>
),
}}
sidebar={{
defaultOpenLevel: 1,
collapsible: true,
banner: (
<a
href="https://github.com/ComposioHQ/agent-orchestrator"
target="_blank"
rel="noreferrer noopener"
className="flex items-center gap-2 text-xs text-[var(--color-text-secondary)] hover:text-[var(--color-text-primary)] transition-colors py-1"
>
<GithubIcon />
<span>ComposioHQ/agent-orchestrator</span>
<GitHubStars />
</a>
),
}}
>
{children}
</DocsLayout>
</RootProvider>
);
}

View File

@ -0,0 +1,5 @@
import { DocsMissingPage } from "@/components/docs/DocsMissingPage";
export default function DocsNotFound() {
return <DocsMissingPage />;
}