Skip to content

V2 documentation #171

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.

Sign up for GitHub

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 39 commits into from
May 30, 2025
Merged

V2 documentation #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
f0d3623
V2 documentation
jhaynie May 25, 2025
af84042
more re-org for settings
jhaynie May 25, 2025
cf5bc61
use a table
jhaynie May 25, 2025
49a690c
try and build
jhaynie May 25, 2025
0edcab6
placeholder for guides
jhaynie May 25, 2025
d36d47c
attempt to fix https://github.com/agentuity/docs/security/dependabot/2
jhaynie May 25, 2025
3705cc2
attempt upgrade to get past issue
jhaynie May 25, 2025
c7d39c6
fix theme when using system default
jhaynie May 25, 2025
4efdd87
small tweaks
jhaynie May 25, 2025
95f6074
add placeholder for guides
jhaynie May 25, 2025
cc43c48
add meta to help order the guides
jhaynie May 25, 2025
0c0273b
consistent descriptions (remove periods)
jhaynie May 25, 2025
7d08470
better ordering
jhaynie May 25, 2025
4cbcecc
add ai gateway and more reordering
jhaynie May 25, 2025
ed07edb
agent cloud
rblalock May 25, 2025
4a62244
udpate agent cloud
rblalock May 25, 2025
7924505
agent cloud tweaks
rblalock May 25, 2025
efaebd5
WIP for agent-to-agent guideg
jhaynie May 25, 2025
8cf114a
improve follow x button
jhaynie May 25, 2025
16b4fce
agent streaming
rblalock May 25, 2025
7f9ee6c
Merge branch 'v2' of github.com:agentuity/docs into v2
rblalock May 25, 2025
a189fc3
more content
jhaynie May 25, 2025
57ef0af
Fix title.
rblalock May 25, 2025
98555ec
Merge branch 'v2' of github.com:agentuity/docs into v2
rblalock May 25, 2025
a1469e1
more visual improvements
jhaynie May 25, 2025
ef80818
more visual tweaks and content improvements
jhaynie May 25, 2025
0babd4f
spelling and grammar check
jhaynie May 25, 2025
5a0ee8d
Refactor code blocks and more cleanup
jhaynie May 25, 2025
badefeb
more formatting, consistency and general wording
jhaynie May 25, 2025
7f7191f
add more content for guides
jhaynie May 25, 2025
a138cdb
more formatting
jhaynie May 25, 2025
7f8aac9
more cleanup
jhaynie May 25, 2025
ba7aa44
small nits
jhaynie May 25, 2025
f7ae9c3
small tweaks
jhaynie May 25, 2025
015700c
Update Frameworks docs; update `agentuity new` -> `create`
mcongrove May 26, 2025
0bd3a22
Styling; hide unused pages
mcongrove May 30, 2025
ddd6f4e
Hide guide list page
mcongrove May 30, 2025
a948048
Remove guide list page from meta.json
mcongrove May 30, 2025
2b8b803
Tweaks
mcongrove May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,7 @@ yarn-error.log*
.vercel
next-env.d.ts
.open-next
.wrangler
.wrangler

# this is generated by the build process
content/docs.json
39 changes: 37 additions & 2 deletions app/(docs)/[[...slug]]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
import { CLICommand } from "@/components/CLICommand";
import { CodeExample } from "@/components/CodeExample";
import { Mermaid } from "@/components/Mermaid";
import { Sparkle } from "@/components/Sparkle";
import { ThemeImage } from "@/components/ThemeImage";
import { TypingAnimation } from "@/components/TypingAnimation";
import { XButton } from "@/components/XButton";
import { source } from "@/lib/source";
import { Popup, PopupContent, PopupTrigger } from "fumadocs-twoslash/ui";
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
Expand All @@ -9,7 +16,8 @@ import {
DocsTitle,
} from "fumadocs-ui/page";
import { notFound } from "next/navigation";
import { Code } from "../../../components/Code";
import { CommunityButton } from "../../../components/Community";
import { NavButton } from "../../../components/NavButton";

export default async function Page(props: {
params: Promise<{ slug?: string[] }>;
Expand Down Expand Up @@ -41,11 +49,38 @@ export default async function Page(props: {
Popup,
PopupContent,
PopupTrigger,
Code,
CodeExample,
CLICommand,
CommunityButton,
Mermaid,
NavButton,
Sparkle,
Tab,
Tabs,
ThemeImage,
TypingAnimation,
}}
/>
<div className="mt-12 border p-4 rounded-lg bg-fd-card">
<h3 className="mt-1 text-fd-foreground">Need Help?</h3>
<p>
Join our <CommunityButton noBorder /> for assistance or just to hang
with other humans building agents.
</p>
<p>
Send us an email at{" "}
<a href="mailto:hi@agentuity.com">hi@agentuity.com</a> if you&apos;d
like to get in touch.
</p>
<p className="flex items-center gap-2">
Please <XButton follow noBorder />
</p>
<p>
If you haven&apos;t already, please{" "}
<a href="https://app.agentuity.com/sign-up">Signup</a> for your free
account now and start building your first agent!
</p>
</div>
</DocsBody>
</DocsPage>
);
Expand Down
30 changes: 2 additions & 28 deletions app/(docs)/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,12 @@
import { baseOptions } from "@/app/layout.config";
import { source } from "@/lib/source";
import { DocsLayout } from "fumadocs-ui/layouts/notebook";

import type { ReactNode } from "react";
// import { RootToggle } from "fumadocs-ui/components/layout/root-toggle";

export default function Layout({ children }: { children: ReactNode }) {
return (
<DocsLayout
tree={source.pageTree}
{...baseOptions}
// sidebar={{
// banner: (
// <RootToggle
// options={[
// {
// title: "Documentation",
// description: "Agentuity Cloud",
// url: "/docs/",
// },
// {
// title: "SDKs",
// description: "Agentuity SDKs",
// url: "/docs/SDKs",
// },
// // {
// // title: "API",
// // description: "Agentuity API",
// // url: "/docs/api",
// // },
// ]}
// />
// ),
// }}
>
<DocsLayout {...baseOptions} tree={source.pageTree}>
{children}
</DocsLayout>
);
Expand Down
137 changes: 134 additions & 3 deletions app/global.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,49 @@
--color-gray-800: var(--color-zinc-800);
--color-gray-900: var(--color-zinc-900);
--color-gray-950: var(--color-zinc-950);

--shadow-md: none;

--color-fd-background: var(--color-white);
--color-fd-foreground: var(--color-cyan-900);
--color-fd-muted: var(--color-cyan-100);
--color-fd-muted-foreground: var(--color-cyan-700);
--color-fd-popover: var(--color-cyan-50);
--color-fd-popover-foreground: var(--color-cyan-900);
--color-fd-card: var(--color-white);
--color-fd-card-foreground: var(--color-cyan-900);
--color-fd-border: var(--color-gray-200);
--color-fd-primary: var(--color-cyan-700);
--color-fd-primary-foreground: var(--color-cyan-50);
--color-fd-secondary: var(--color-cyan-100);
--color-fd-secondary-foreground: var(--color-cyan-900);
--color-fd-accent: var(--color-cyan-100);
--color-fd-accent-foreground: var(--color-cyan-900);
--color-fd-ring: var(--color-cyan-500);
}

.dark {
--color-fd-background: var(--color-cyan-900);
--color-fd-foreground: var(--color-white);
--color-fd-muted: var(--color-cyan-900);
--color-fd-muted-foreground: var(--color-gray-400);
--color-fd-popover: var(--color-cyan-900);
--color-fd-popover-foreground: var(--color-cyan-50);
--color-fd-card: var(--color-black);
--color-fd-card-foreground: var(--color-cyan-50);
--color-fd-border: var(--color-cyan-900);
--color-fd-primary: var(--color-cyan-200);
--color-fd-primary-foreground: var(--color-cyan-900);
--color-fd-secondary: var(--color-cyan-900);
--color-fd-secondary-foreground: var(--color-cyan-100);
--color-fd-accent: var(--color-cyan-900);
--color-fd-accent-foreground: var(--color-cyan-100);
--color-fd-ring: var(--color-cyan-300);
}

.dark body,
.dark main {
background-color: #011;
}

aside [data-radix-scroll-area-viewport] button,
Expand All @@ -42,11 +85,99 @@ aside [data-radix-scroll-area-viewport] a {
background: #FAFAFA;
}

.dark aside {
background: #18181A;
.dark aside,
.dark header {
background: #011;
}

.dark aside [data-radix-scroll-area-viewport] button,
.dark aside [data-radix-scroll-area-viewport] a {
color: #FFF;
}
}

/* make sure empty lines are rendered */
code span.line:empty:before {
content: "\200b";
}

code span.line > span {
white-space: pre !important;
}

.code-example > div[role="tablist"] {
background-color: #EEE;
}

.dark .code-example > div[role="tablist"] {
background-color: #000;
}

.mermaid .cluster rect {
fill: #FFF !important;
stroke: #099 !important;
}

.dark .mermaid .cluster rect {
fill: #111 !important;
stroke: #099 !important;
}

.mermaid .flowchart-link {
stroke: #999 !important;
}

.mermaid .marker {
stroke: #999 !important;
fill: #777 !important;
}

.mermaid rect.label-container {
fill: rgba(150, 236, 236, 0.1) !important;
stroke: #099 !important;
stroke-dasharray: 2 2 !important;
}

.dark .mermaid .nodeLabel {
color: #FFF !important;
}

.mermaid text.actor > tspan {
font-size: 11px;
}

.mermaid .messageText {
font-size: 12px !important;
}

.mermaid .messageLine0,
.mermaid .messageLine1 {
stroke: #099 !important;
}

.prose blockquote {
border: 2px solid var(--color-cyan-600);
background-color: var(--color-cyan-50);
font-style: normal;
border-radius: 0.5rem;
}

.dark .prose blockquote {
border: 1px solid var(--color-cyan-800);
background-color: var(--color-gray-950);
}

.prose {
:where(blockquote p:first-of-type):not(
:where([class~="not-prose"], [class~="not-prose"] *)
)::before {
content: "";
}
}

.dark .prose hr {
border-color: var(--color-cyan-800);
}

article > p {
margin-bottom: 1rem;
}
61 changes: 21 additions & 40 deletions app/layout.config.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
import { Github } from "lucide-react";
import { CommunityButton } from "../components/Community";
import { NavButton } from "../components/NavButton";
import { XButton } from "../components/XButton";

/**
* Shared layout configurations
*/
export const baseOptions: BaseLayoutProps = {
githubUrl: "https://github.com/agentuity",
nav: {
url: "/Introduction",
title: (
Expand Down Expand Up @@ -34,43 +37,21 @@ export const baseOptions: BaseLayoutProps = {
</div>
),
},
// links: [
// {
// text: "Documentation",
// url: "/docs",
// active: "nested-url",
// },
// {
// type: "menu",
// text: "SDKs",
// items: [
// {
// text: "Python",
// description: "The Python SDK for Agentuity",
// url: "/docs/sdks/python",
// // (optional) Props for Radix UI Navigation Menu item in Home Layout
// menu: {
// className: "row-span-2",
// // add banner to navigation menu card
// // can be an image or other elements
// banner: <div>Python based SDKs</div>,
// },
// },
// {
// text: "JavaScript",
// description: "The JavaScript SDK for Agentuity",
// url: "/docs/sdks/javascript",
// menu: {
// className: "row-span-2",
// banner: <div>JavaScript based SDKs</div>,
// },
// },
// ],
// },
// {
// text: "API",
// url: "/docs/api",
// active: "nested-url",
// },
// ],
links: [
{
type: "custom",
on: "nav",
children: (
<div className="flex items-center gap-2 text-sm">
<NavButton href="https://agentuity.com/blog">Blog</NavButton>
<NavButton href="https://app.agentuity.com">Console</NavButton>
<CommunityButton />
<XButton className="h-9" />
<NavButton href="https://github.com/agentuity" className="h-9">
<Github className="size-4" />
</NavButton>
</div>
),
},
],
};
12 changes: 5 additions & 7 deletions app/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
import { RootProvider } from "fumadocs-ui/provider";
import { Geist } from "next/font/google";
import { GeistSans } from "geist/font/sans";
import type { ReactNode } from "react";
import "./global.css";

const geist = Geist({
subsets: ["latin"],
});

export default function Layout({ children }: { children: ReactNode }) {
return (
<html lang="en" className={geist.className} suppressHydrationWarning>
<html lang="en" className={GeistSans.className} suppressHydrationWarning>
<body className="flex flex-col min-h-screen antialiased">
<RootProvider>{children}</RootProvider>
<RootProvider theme={{ enabled: true, enableSystem: true }}>
{children}
</RootProvider>
</body>
</html>
);
Expand Down
22 changes: 22 additions & 0 deletions components/CLICommand.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { CodeBlock } from "fumadocs-ui/components/codeblock";

export interface CLICommandProps {
command: string;
children?: React.ReactNode;
}

export function CLICommand({ command, children }: CLICommandProps) {
return (
<CodeBlock lang="bash" className="p-3">
<span className="flex items-start justify-start gap-2">
<span className="text-cyan-700 dark:text-cyan-700 select-none">$</span>{" "}
<pre>{command}</pre>
</span>
Comment on lines +12 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix semantic HTML structure issue.

Using a <pre> element inside a <span> violates HTML semantics. The <pre> element is block-level and should not be nested inside inline elements.

-			<span className="flex items-start justify-start gap-2">
-				<span className="text-cyan-700 dark:text-cyan-700 select-none">$</span>{" "}
-				<pre>{command}</pre>
-			</span>
+			<div className="flex items-start justify-start gap-2">
+				<span className="text-cyan-700 dark:text-cyan-700 select-none">$</span>
+				<span className="font-mono whitespace-pre-wrap">{command}</span>
+			</div>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<span className="text-cyan-700 dark:text-cyan-700 select-none">$</span>{" "}
<pre>{command}</pre>
</span>
<div className="flex items-start justify-start gap-2">
<span className="text-cyan-700 dark:text-cyan-700 select-none">$</span>
<span className="font-mono whitespace-pre-wrap">{command}</span>
</div>
🤖 Prompt for AI Agents 
In components/CLICommand.tsx around lines 12 to 14, the <pre> element is
incorrectly nested inside a <span>, which violates HTML semantics because <pre>
is block-level and <span> is inline. To fix this, replace the outer <span> with
a block-level element such as a <div> or restructure the markup so that the
<pre> is not inside an inline element, ensuring proper semantic HTML structure.

{children && (
<div className="nd-copy-ignore mt-4 mb-1 text-yellow-600 dark:text-yellow-500 whitespace-break-spaces font-mono">
{children}
</div>
)}
</CodeBlock>
);
}
Loading