V2 documentation #171
V2 documentation #171
Conversation
WalkthroughThis update introduces a comprehensive set of changes across the documentation and codebase. It adds new guides, expands and restructures Cloud and SDK documentation, introduces several new React UI components, and updates styling and configuration files. Several placeholder or obsolete integration files are removed. The documentation now uses custom components for CLI command rendering, and new features like Mermaid diagram support and theme-aware images are included. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsPage
participant MDXRenderer
participant CustomComponents
participant CommunityButton
participant XButton
User->>DocsPage: Navigate to docs page
DocsPage->>MDXRenderer: Render MDX content with custom components
MDXRenderer->>CustomComponents: Render CLICommand, CodeExample, Mermaid, etc.
DocsPage->>CommunityButton: Render "Join Community" button
DocsPage->>XButton: Render "Follow on X" button
DocsPage-->>User: Display docs content with new help section and enhanced features
sequenceDiagram
participant User
participant ThemeImage
participant ThemeProvider
User->>ThemeImage: Page loads themed image
ThemeImage->>ThemeProvider: Detect current theme (light/dark)
ThemeProvider-->>ThemeImage: Provide theme info
ThemeImage-->>User: Render appropriate image variant
sequenceDiagram
participant User
participant Mermaid
participant ThemeProvider
participant MermaidLib
User->>Mermaid: Pass chart string
Mermaid->>ThemeProvider: Get current theme
Mermaid->>MermaidLib: Render chart with theme
MermaidLib-->>Mermaid: Return SVG
Mermaid-->>User: Display Mermaid diagram
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
npm error Exit handler never called! ✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 2b8b803 | Visit preview | May 30 2025, 06:18 PM |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 18
🔭 Outside diff range comments (1)
content/SDKs/javascript/troubleshooting.mdx (1)
24-27:⚠️ Potential issueFix list numbering.
The "Getting Additional Help" section misnumbers the third item as "4." instead of "3.":- 4. File an issue on the [GitHub repository](https://github.com/agentuity/sdk-js/issues) if you believe you've found a bug. + 3. File an issue on the [GitHub repository](https://github.com/agentuity/sdk-js/issues) if you believe you've found a bug.
🧹 Nitpick comments (47)
.gitignore (1)
30-31: Use directory notation for.wranglerentry.
If.wrangleris a folder generated by your tooling, it’s clearer to append a slash (.wrangler/) so you ignore the directory and all its contents explicitly.content/Guides/.agent-telemetry.mdx (1)
1-5: Add initial body content
As-is, this page will render blank beyond the frontmatter. Please add at least a heading or a placeholder sentence (e.g., an intro paragraph or aTODOnote) to avoid shipping an empty page.content/Guides/.agent-logging.mdx (1)
5-5: Empty guide: add content before merging
Currently the page only contains frontmatter and will render as a blank page. Please populate it with introductory text, examples, or at least a placeholder section to ensure users see meaningful content.
Would you like assistance drafting an outline for this guide?components/Sparkle.tsx (1)
1-24: LGTM! Well-implemented accessible SVG icon component.The component follows good practices with proper accessibility attributes and theme support.
Consider making the component more flexible by accepting optional props:
-export function Sparkle() { +interface SparkleProps { + className?: string; + size?: number; +} + +export function Sparkle({ className, size = 24 }: SparkleProps = {}) { return ( <svg xmlns="http://www.w3.org/2000/svg" - width="24" - height="24" + width={size} + height={size} viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" - className="lucide lucide-sparkles size-4 text-purple-600 dark:text-cyan-500" + className={cn("lucide lucide-sparkles size-4 text-purple-600 dark:text-cyan-500", className)} aria-label="Sparkle" >content/Introduction/templates.mdx (1)
1-60: LGTM! Comprehensive and well-structured documentation.The documentation provides clear information about supported frameworks and providers with helpful tables and examples.
Consider adding a comma before "and" for better readability:
-The Agentuity Template system is fully open source and you can create your own templates by forking the [Agentuity Template repository](https://github.com/agentuity/templates) and making a pull request. +The Agentuity Template system is fully open source, and you can create your own templates by forking the [Agentuity Template repository](https://github.com/agentuity/templates) and making a pull request.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ity Template system is fully open source and you can create your own templates by fo...(COMMA_COMPOUND_SENTENCE)
components/TypingAnimation.tsx (1)
1-90: LGTM! Well-implemented typing animation component with proper cleanup.The component correctly uses React hooks, implements proper cleanup for timers and observers, and provides flexible configuration options.
Consider removing the commented code for cleaner implementation:
className={cn( - // "text-4xl font-bold leading-[5rem] tracking-[-0.02em]", className, )}content/Changelog/cli.mdx (1)
612-612: Correct capitalization of macOS
The Apple operating system should be styled as “macOS” (lowercase ‘m’) rather than “MacOS”.Apply this diff:
- **Fixed**: Fix MacOS segfault during reinstallation ([#183](https://github.com/agentuity/cli/pull/183)) + **Fixed**: Fix macOS segfault during reinstallation ([#183](https://github.com/agentuity/cli/pull/183))🧰 Tools
🪛 LanguageTool
[grammar] ~612-~612: The operating system from Apple is written “macOS”.
Context: ...entuity/cli/pull/182)) - Fixed: Fix MacOS segfault during reinstallation ([#183](...(MAC_OS)
content/Cloud/settings.mdx (1)
8-8: Refine wording for clarity and consistency.
Consider using singular form and possessive for better readability:- The Settings pages are used to manage your overall organization settings. + The Settings page is used to manage your organization's settings.content/SDKs/python/examples/pydantic.mdx (1)
32-34: Ensure consistent indentation and remove trailing whitespace.
The comment line uses a tab for indentation, while the following code line uses spaces, and there's trailing whitespace at the end of the code line. Align both to 4-space indentation and strip trailing spaces:- # Spin that wheel! + # Spin that wheel! - success_number = random.randint(0, 20) + success_number = random.randint(0, 20)components/Community.tsx (1)
12-24: Use standard Tailwind sizing utilities for the SVGThe class
size-4is not a default Tailwind utility. Replace withh-4 w-4to correctly size the icon:- <svg - fill="none" - className="size-4" + <svg + fill="none" + className="h-4 w-4"components/CodeExample.tsx (2)
4-7: Renamejsprop totsand update language specifierThe tab is labeled “TypeScript” but uses a
jsprop andlang="js". Rename the prop totsand switch tolang="ts"for clarity:-interface CodeExampleProps { - py: string; - js: string; -} +interface CodeExampleProps { + py: string; + ts: string; +} -export function CodeExample({ py, js }: CodeExampleProps) { +export function CodeExample({ py, ts }: CodeExampleProps) { ... - <DynamicCodeBlock code={js} lang="js" /> + <DynamicCodeBlock code={ts} lang="ts" /> ...
11-15: Avoid global tab syncing by using uniquegroupIdA fixed
groupId="code-examples"will sync all instances. Accept agroupIdprop or generate one internally:export function CodeExample({ py, ts, groupId }: CodeExampleProps & { groupId?: string }) { const id = groupId ?? `code-example-${useId()}`; return ( <Tabs items={["TypeScript", "Python"]} persist - groupId="code-examples" + groupId={id} className="code-example" >content/CLI/agent.mdx (2)
13-13: Standardize alias formattingYou updated alias sections to inline bold (
**Aliases:**). Ensure this style is applied consistently across all CLI docs and renders correctly in MDX.Also applies to: 48-48, 80-80, 110-110
38-42: Check interactive prompts and outputsInteractive sessions are now children of
<CLICommand>. Confirm the component preserves whitespace, indentation, and special characters (e.g., “✓”).Also applies to: 97-105, 131-133, 137-143
content/SDKs/python/index.mdx (1)
50-50: Ensure blockquote styling is consistentYou converted the
agent_IDreminder to a blockquote. Check that this matches other usage (e.g., in JavaScript docs) for visual consistency.content/Cloud/aigateway.mdx (1)
32-32: Fix hyphenation for compound modifier.The static analysis tool correctly identified that "provider specific" should be hyphenated when used as a compound modifier.
-To override using the AI Gateway, use the AI provider specific environment variables to configure them. +To override using the AI Gateway, use the AI provider-specific environment variables to configure them.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: When ‘provider-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...erride using the AI Gateway, use the AI provider specific environment variables to configure them...(SPECIFIC_HYPHEN)
components/CLICommand.tsx (2)
1-1: Add explicit React import for better TypeScript support.While modern React setups may auto-import React, it's a best practice to explicitly import React types when using TypeScript interfaces with React.ReactNode.
+import React from "react"; import { CodeBlock } from "fumadocs-ui/components/codeblock";
12-12: Consider using CSS custom properties for theme consistency.The hardcoded cyan-700 color may not integrate well with dynamic theming systems. Consider using CSS custom properties or design tokens for better theme integration.
- <span className="text-cyan-700 dark:text-cyan-700 select-none">$</span>{" "} + <span className="text-primary dark:text-primary select-none">$</span>content/Guides/agent-engineering.mdx (1)
58-58: Minor stylistic improvement suggestionConsider making the question more polite by adding "please":
-### Can you show me a practical example of the difference? +### Can you please show me a practical example of the difference?This addresses the static analysis suggestion for more courteous phrasing.
🧰 Tools
🪛 LanguageTool
[style] ~58-~58: If you’re making a request, consider inserting ‘please’ to sound more courteous and respectful.
Context: ...r input in traditional apps. ---- ### Can you show me a practical example of the diff...(CAN_YOU)
content/CLI/version.mdx (1)
92-92: Fix macOS capitalizationThe operating system should be spelled "macOS" according to Apple's official branding:
-> On MacOS, if the CLI was installed using Homebrew, it will use Homebrew to perform the upgrade. +> On macOS, if the CLI was installed using Homebrew, it will use Homebrew to perform the upgrade.🧰 Tools
🪛 LanguageTool
[grammar] ~92-~92: The operating system from Apple is written “macOS”.
Context: ...to version 0.0.139. > On MacOS, if the CLI was installed using Homebre...(MAC_OS)
components/ThemeImage.tsx (3)
14-15: Consider more reasonable default dimensionsThe default dimensions (3680x2382) seem quite large. Consider using more web-appropriate defaults:
- width = 3680, - height = 2382, + width = 800, + height = 600,Large default dimensions could impact page performance and layout on smaller screens.
16-16: Consider making width and height optional in props interfaceThe props interface could be more explicit about optional parameters:
-}: { baseName: string; alt: string; width: number; height: number }) { +}: { baseName: string; alt: string; width?: number; height?: number }) {This makes the API more clear and aligns with the default parameters.
25-31: Consider adding error handling for image loadingThe component could be more robust with error handling for failed image loads:
useEffect(() => { if (theme === "dark" || (theme === "system" && resolvedTheme === "dark")) { setSrc(`/images/${baseName}-dark.png`); } else { setSrc(`/images/${baseName}-light.png`); } }, [theme, resolvedTheme, baseName]); + + const handleImageError = () => { + // Fallback to a default image or show an error state + setSrc(placeholder); + };Then add
onError={handleImageError}to the img element for better error handling.components/Mermaid.tsx (4)
39-40: Provide specific explanation for biome lint ignore.The generic explanation should be replaced with a specific reason for why the non-null assertion is safe here.
- // biome-ignore lint/style/noNonNullAssertion: <explanation> + // biome-ignore lint/style/noNonNullAssertion: container is guaranteed to exist due to early return check
53-54: Provide specific explanation for dangerouslySetInnerHTML usage.The security implications should be clearly documented since this involves rendering external content.
- // biome-ignore lint/security/noDangerouslySetInnerHtml: <explanation> + // biome-ignore lint/security/noDangerouslySetInnerHtml: SVG content is generated by trusted Mermaid library
6-48: Consider input validation and improved error handling.While the component handles Mermaid rendering errors, consider adding:
- Input validation for the chart string
- User-visible error state instead of only console logging
- Loading state during chart rendering
export function Mermaid({ chart }: { chart: string }) { const id = useId(); const [svg, setSvg] = useState(""); + const [error, setError] = useState<string | null>(null); + const [isLoading, setIsLoading] = useState(false); const containerRef = useRef<HTMLDivElement>(null); const currentChartRef = useRef<string>(null); const { theme, resolvedTheme } = useTheme(); useEffect(() => { + if (!chart || typeof chart !== 'string') { + setError('Invalid chart data provided'); + return; + } + const container = containerRef.current; if (!container) return; currentChartRef.current = chart; + setIsLoading(true); + setError(null); async function renderChart() { try { // ... existing mermaid rendering code ... setSvg(svg); + setError(null); } catch (error) { console.error("Error while rendering mermaid", error); + setError('Failed to render diagram'); + } finally { + setIsLoading(false); } } void renderChart(); }, [chart, id, resolvedTheme, theme]); + if (error) { + return <div className="text-red-500 p-4 border border-red-200 rounded">Error: {error}</div>; + } + + if (isLoading) { + return <div className="p-4">Loading diagram...</div>; + } return ( <div ref={containerRef} dangerouslySetInnerHTML={{ __html: svg }} className="mermaid" /> ); }
36-36: Validate string replacement operation.The
replaceAll("\\n", "\n")operation should be safe, but consider documenting why this transformation is necessary.Add a comment explaining the newline replacement:
+ // Convert escaped newlines to actual newlines for proper Mermaid parsing const { svg, bindFunctions } = await mermaid.render( id, chart.replaceAll("\\n", "\n"), );content/CLI/env.mdx (2)
14-23: Format the secret flag consistently
The-s, --secretentry is missing a leading markdown list bullet and backticks around the flag. For consistency, change to:- -s, --secret Force the value(s) to be treated as a secret + - `-s, --secret` - Force the value(s) to be treated as a secret
59-67: Consolidate flag description into a single sentence
The--formatflag description is split into two sentences. Consider merging for clarity, e.g.:- `--format string` - The format to use for the output. Can be either 'text' or 'json' (default "text") + `--format string` - The format to use for the output; can be either 'text' or 'json' (default "text")🧰 Tools
🪛 LanguageTool
[style] ~65-~65: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ng` - The format to use for the output. Can be either 'text' or 'json' (default "te...(MISSING_IT_THERE)
content/CLI/project.mdx (2)
16-29: Consolidate--formatflag description and verify defaults
The--formatflag description spans two sentences; consider merging:- `--format string` - The format to use for the output. Can be either 'text' or 'json' (default "text") + `--format string` - The format to use for the output; can be either 'text' or 'json' (default "text")All other flags and usage for
project createlook correct.🧰 Tools
🪛 LanguageTool
[style] ~23-~23: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ng` - The format to use for the output. Can be either 'text' or 'json' (default "te...(MISSING_IT_THERE)
61-66: Standardize alias style forproject delete
The alias line reads**Aliases**: rm, delbut other files use**Aliases:**. For consistency, adjust to:- **Aliases**: rm, del + **Aliases:** rm, delcontent/Guides/what-is-an-agent.mdx (2)
24-24: Use more concise phrasing
Consider replacing "have the ability to decide how to achieve a goal" with "can decide how to achieve a goal" to improve readability.🧰 Tools
🪛 LanguageTool
[style] ~24-~24: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ...y contrast, are autonomous actors. They have the ability to decide how to achieve a goal, not just ...(HAS_THE_ABILITY_TO)
67-67: Clarify use of “compute” as a noun
The phrase "moving the compute to the edge" is unconventional. Consider "moving compute to the edge" or "moving compute resources to the edge."🧰 Tools
🪛 LanguageTool
[grammar] ~67-~67: The verb ‘compute’ does not usually follow articles like ‘the’. Check that ‘compute’ is spelled correctly; using ‘compute’ as a noun may be non-standard.
Context: ...mized cloud computing largely by moving the compute to the edge, focusing on horizontal sca...(A_INFINITIVE)
content/Guides/agent-streaming.mdx (1)
38-43: Add missing comma for introductory phrase
To improve readability, add a comma after "Under the hood":- Under the hood Agentuity handles the details of the streaming input and output for you. + Under the hood, Agentuity handles the details of the streaming input and output for you.🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: A comma might be missing here.
Context: ... client's incoming stream. 3. Under the hood Agentuity handles the details of the st...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
content/Introduction/index.mdx (2)
55-57: Use correct casing for macOS. “MacOS” should be “macOS” to match official branding.-... supports Windows (using WSL), MacOS, and Linux. +... supports Windows (using WSL), macOS, and Linux.🧰 Tools
🪛 LanguageTool
[grammar] ~56-~56: The operating system from Apple is written “macOS”.
Context: ...Cloud. It supports Windows (using WSL), MacOS, and Linux. <CLICommand command="curl ...(MAC_OS)
72-73: Improve clarity and correct terminology. Add a proper separator and use “log in” (verb) instead of “login” (noun):-You can skip this step if you used the CLI to sign up for an account, otherwise you must login to your account using the CLI. +You can skip this step if you used the CLI to sign up for an account; otherwise, you must log in to your account using the CLI.🧰 Tools
🪛 LanguageTool
[typographical] ~72-~72: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...p if you used the CLI to sign up for an account, otherwise you must login to your account using th...(THUS_SENTENCE)
[misspelling] ~72-~72: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...n up for an account, otherwise you must login to your account using the CLI. <CLICom...(LOG_IN)
content/CLI/installation.mdx (3)
3-3: Fix typo in frontmatter description. "Insructions" should be "Instructions".-description: Insructions for installing the CLI +description: Instructions for installing the CLI
7-7: Use correct casing for macOS.-The Agentuity CLI is a command line tool for managing your Agentuity projects. It's a cross-platform tool that can be used on Windows (using WSL), MacOS, and Linux. +The Agentuity CLI is a command line tool for managing your Agentuity projects. It's a cross-platform tool that can be used on Windows (using WSL), macOS, and Linux.🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: The operating system from Apple is written “macOS”.
Context: ...hat can be used on Windows (using WSL), MacOS, and Linux. ### Install Script The ea...(MAC_OS)
65-65: Use correct casing for macOS.- - **Bash and Zsh** on MacOS and Linux (when you have write permissions to the completion directories) + - **Bash and Zsh** on macOS and Linux (when you have write permissions to the completion directories)🧰 Tools
🪛 LanguageTool
[grammar] ~65-~65: The operating system from Apple is written “macOS”.
Context: ...cally set up for: - Bash and Zsh on MacOS and Linux (when you have write permissi...(MAC_OS)
content/Guides/agent-native-cloud.mdx (2)
6-9: Standardize compound word spelling. Replace "micro-services" with "microservices" for consistency.-...retro-fitted for them. Instead of asking agents to squeeze into workflows that were built for humans or stateless micro-services, an agent-native cloud... +...retro-fitted for them. Instead of asking agents to squeeze into workflows that were built for humans or stateless microservices, an agent-native cloud...🧰 Tools
🪛 LanguageTool
[misspelling] ~8-~8: This word is normally spelled as one.
Context: ...that were built for humans or stateless micro-services, an agent-native cloud gives them nativ...(EN_COMPOUNDS_MICRO_SERVICES)
105-108: Standardize compound word spelling. Replace "boiler-plate" with "boilerplate".-• **Developers** – Focus on behaviour, not boiler-plate. Agentuity gives you SDKs, simulators, and debugging tailored to agent logic. +• **Developers** – Focus on behaviour, not boilerplate. Agentuity gives you SDKs, simulators, and debugging tailored to agent logic.🧰 Tools
🪛 LanguageTool
[misspelling] ~107-~107: This word is normally spelled as one.
Context: ...Developers* – Focus on behaviour, not boiler-plate. Agentuity gives you SDKs, simulators, ...(EN_COMPOUNDS_BOILER_PLATE)
content/Cloud/agents.mdx (1)
14-15: Add missing article and comma for clarity. Enhance readability by adding punctuation and an article.-The agent detail page provides a list of the agent's inputs and outputs, recent sessions and overview of costs. +The agent detail page provides a list of the agent's inputs and outputs, recent sessions, and an overview of costs.🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: You might be missing the article “an” here.
Context: ...inputs and outputs, recent sessions and overview of costs. <ThemeImage baseName="agent-...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
content/Guides/agent-communication.mdx (4)
6-8: Image component alt text needs a space
Thealtvalue"Agent-to-AgentCommunication"should be"Agent-to-Agent Communication"for readability and accessibility.Apply this diff:
- <Image src="/images/agent-to-agent.png" alt="Agent-to-AgentCommunication" width={640} height={640} /> + <Image src="/images/agent-to-agent.png" alt="Agent-to-Agent Communication" width={640} height={640} />
42-43: Fix subject-verb agreement
Change “Agents has two primary methods” to “Agents have two primary methods.”- Agents has two primary methods of communication with other agents: + Agents have two primary methods of communication with other agents:🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...rk. #### Communication Methods Agents has two primary methods of communication wi...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
44-47: Use “hand off” as the verb form
When describing the action, use “hand off” instead of “handoff” (the latter is a noun).- | Handoff | Agents can handoff a request to another agent to complete | + | Handoff | Agents can hand off a request to another agent to complete |🧰 Tools
🪛 LanguageTool
[grammar] ~46-~46: The word “handoff” is a noun. The verb is spelled with a space.
Context: ...-|-------------| | Handoff | Agents can handoff a request to another agent to complete ...(NOUN_VERB_CONFUSION)
51-55: Consistent verb usage for hand-off
In the descriptive text, replace “needs to handoff a request” with “needs to hand off a request.”- When an agent needs to handoff a request to another agent, it can do so by using the SDK `handoff` method. + When an agent needs to hand off a request to another agent, it can do so by using the SDK `handoff` method.🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: The word “handoff” is a noun. The verb is spelled with a space.
Context: ... ##### Handoff When an agent needs to handoff a request to another agent, it can do s...(NOUN_VERB_CONFUSION)
[grammar] ~53-~53: You can use the subjunctive mood in this context.
Context: ...t and can complete the request as if it was the original request. A trivial exampl...(SUBJUNCTIVE_MOOD)
content/Introduction/architecture.mdx (1)
49-53: Web Console numbering
The Web Console item is numbered “4.” but should be “5.” to follow the SDKs entry.- 4. **Web Console** - A management interface offering: + 5. **Web Console** - A management interface offering:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (76)
package-lock.jsonis excluded by!**/package-lock.jsonpublic/images/agent-deployment-dark.pngis excluded by!**/*.pngpublic/images/agent-deployment-detail-dark.pngis excluded by!**/*.pngpublic/images/agent-deployment-detail-light.pngis excluded by!**/*.pngpublic/images/agent-deployment-light.pngis excluded by!**/*.pngpublic/images/agent-detail-dark.pngis excluded by!**/*.pngpublic/images/agent-detail-light.pngis excluded by!**/*.pngpublic/images/agent-io-api-source-dark.pngis excluded by!**/*.pngpublic/images/agent-io-api-source-light.pngis excluded by!**/*.pngpublic/images/agent-io-cron-source-dark.pngis excluded by!**/*.pngpublic/images/agent-io-cron-source-light.pngis excluded by!**/*.pngpublic/images/agent-io-cron-trigger-dark.pngis excluded by!**/*.pngpublic/images/agent-io-cron-trigger-light.pngis excluded by!**/*.pngpublic/images/agent-io-email-source-dark.pngis excluded by!**/*.pngpublic/images/agent-io-email-source-light.pngis excluded by!**/*.pngpublic/images/agent-io-new-dark.pngis excluded by!**/*.pngpublic/images/agent-io-new-light.pngis excluded by!**/*.pngpublic/images/agent-io-webhook-source-dark.pngis excluded by!**/*.pngpublic/images/agent-io-webhook-source-light.pngis excluded by!**/*.pngpublic/images/agent-log-dark.pngis excluded by!**/*.pngpublic/images/agent-log-detail-dark.pngis excluded by!**/*.pngpublic/images/agent-log-detail-light.pngis excluded by!**/*.pngpublic/images/agent-log-light.pngis excluded by!**/*.pngpublic/images/agent-logs-dark.pngis excluded by!**/*.pngpublic/images/agent-logs-detail-dark.pngis excluded by!**/*.pngpublic/images/agent-logs-detail-light.pngis excluded by!**/*.pngpublic/images/agent-logs-light.pngis excluded by!**/*.pngpublic/images/agent-project-detail-dark.pngis excluded by!**/*.pngpublic/images/agent-project-detail-light.pngis excluded by!**/*.pngpublic/images/agent-session-detail-dark.pngis excluded by!**/*.pngpublic/images/agent-session-detail-light.pngis excluded by!**/*.pngpublic/images/agent-session-detail-sidebar-dark.pngis excluded by!**/*.pngpublic/images/agent-session-detail-sidebar-light.pngis excluded by!**/*.pngpublic/images/agent-to-agent.pngis excluded by!**/*.pngpublic/images/agents-dark.pngis excluded by!**/*.pngpublic/images/agents-light.pngis excluded by!**/*.pngpublic/images/aigateway-dark.pngis excluded by!**/*.pngpublic/images/aigateway-detail-dark.pngis excluded by!**/*.pngpublic/images/aigateway-detail-light.pngis excluded by!**/*.pngpublic/images/aigateway-light.pngis excluded by!**/*.pngpublic/images/apikey-dark.pngis excluded by!**/*.pngpublic/images/apikey-light.pngis excluded by!**/*.pngpublic/images/apikey-new-dark.pngis excluded by!**/*.pngpublic/images/apikey-new-light.pngis excluded by!**/*.pngpublic/images/cli-rollback-dark.pngis excluded by!**/*.pngpublic/images/cli-rollback-detail-dark.pngis excluded by!**/*.pngpublic/images/cli-rollback-detail-light.pngis excluded by!**/*.pngpublic/images/cli-rollback-light.pngis excluded by!**/*.pngpublic/images/github-action-dark.pngis excluded by!**/*.pngpublic/images/github-action-light.pngis excluded by!**/*.pngpublic/images/keyvalue-dark.pngis excluded by!**/*.pngpublic/images/keyvalue-detail-dark.pngis excluded by!**/*.pngpublic/images/keyvalue-detail-light.pngis excluded by!**/*.pngpublic/images/keyvalue-light.pngis excluded by!**/*.pngpublic/images/keyvalue-new-dark.pngis excluded by!**/*.pngpublic/images/keyvalue-new-light.pngis excluded by!**/*.pngpublic/images/project-env-dark.pngis excluded by!**/*.pngpublic/images/project-env-light.pngis excluded by!**/*.pngpublic/images/project-integration-dark.pngis excluded by!**/*.pngpublic/images/project-integration-github-dark.pngis excluded by!**/*.pngpublic/images/project-integration-github-light.pngis excluded by!**/*.pngpublic/images/project-integration-light.pngis excluded by!**/*.pngpublic/images/projects-dark.pngis excluded by!**/*.pngpublic/images/projects-light.pngis excluded by!**/*.pngpublic/images/sessions-dark.pngis excluded by!**/*.pngpublic/images/sessions-light.pngis excluded by!**/*.pngpublic/images/settings-integration-github-dark.pngis excluded by!**/*.pngpublic/images/settings-integration-github-light.pngis excluded by!**/*.pngpublic/images/settings-org-dark.pngis excluded by!**/*.pngpublic/images/settings-org-light.pngis excluded by!**/*.pngpublic/images/vector-dark.pngis excluded by!**/*.pngpublic/images/vector-detail-dark.pngis excluded by!**/*.pngpublic/images/vector-detail-light.pngis excluded by!**/*.pngpublic/images/vector-light.pngis excluded by!**/*.pngpublic/images/vector-new-dark.pngis excluded by!**/*.pngpublic/images/vector-new-light.pngis excluded by!**/*.png
📒 Files selected for processing (86)
.gitignore(1 hunks)app/(docs)/[[...slug]]/page.tsx(3 hunks)app/(docs)/layout.tsx(1 hunks)app/global.css(2 hunks)app/layout.config.tsx(2 hunks)app/layout.tsx(1 hunks)components/CLICommand.tsx(1 hunks)components/Code.tsx(0 hunks)components/CodeExample.tsx(1 hunks)components/Community.tsx(1 hunks)components/Mermaid.tsx(1 hunks)components/NavButton.tsx(1 hunks)components/Sparkle.tsx(1 hunks)components/ThemeImage.tsx(1 hunks)components/TypingAnimation.tsx(1 hunks)components/XButton.tsx(1 hunks)content/CLI/agent.mdx(7 hunks)content/CLI/apikey.mdx(1 hunks)content/CLI/auth.mdx(2 hunks)content/CLI/bundle.mdx(2 hunks)content/CLI/cloud.mdx(2 hunks)content/CLI/dev.mdx(1 hunks)content/CLI/env.mdx(2 hunks)content/CLI/installation.mdx(3 hunks)content/CLI/mcp.mdx(2 hunks)content/CLI/meta.json(1 hunks)content/CLI/project.mdx(3 hunks)content/CLI/version.mdx(2 hunks)content/Changelog/cli.mdx(1 hunks)content/Changelog/index.mdx(1 hunks)content/Changelog/sdk-js.mdx(0 hunks)content/Changelog/sdk-py.mdx(0 hunks)content/Cloud/agents.mdx(1 hunks)content/Cloud/aigateway.mdx(1 hunks)content/Cloud/api-keys.mdx(3 hunks)content/Cloud/index.mdx(1 hunks)content/Cloud/key-value-memory.mdx(2 hunks)content/Cloud/meta.json(1 hunks)content/Cloud/organization.mdx(1 hunks)content/Cloud/project.mdx(1 hunks)content/Cloud/settings.mdx(1 hunks)content/Cloud/vector-memory.mdx(2 hunks)content/Examples/index.mdx(3 hunks)content/Guides/.agent-data-handling.mdx(1 hunks)content/Guides/.agent-io.mdx(1 hunks)content/Guides/.agent-logging.mdx(1 hunks)content/Guides/.agent-patterns.mdx(1 hunks)content/Guides/.agent-telemetry.mdx(1 hunks)content/Guides/.agent-tracing.mdx(1 hunks)content/Guides/.ai-gateway.mdx(1 hunks)content/Guides/.devmode.mdx(1 hunks)content/Guides/.key-value.mdx(1 hunks)content/Guides/.security.mdx(1 hunks)content/Guides/.vector-db.mdx(1 hunks)content/Guides/agent-communication.mdx(1 hunks)content/Guides/agent-engineering.mdx(1 hunks)content/Guides/agent-native-cloud.mdx(1 hunks)content/Guides/agent-streaming.mdx(1 hunks)content/Guides/meta.json(1 hunks)content/Guides/what-is-an-agent.mdx(1 hunks)content/Integrations/index.mdx(0 hunks)content/Integrations/slack.mdx(0 hunks)content/Integrations/sms.mdx(0 hunks)content/Integrations/webhooks.mdx(0 hunks)content/Introduction/architecture.mdx(5 hunks)content/Introduction/index.mdx(3 hunks)content/Introduction/meta.json(1 hunks)content/Introduction/templates.mdx(1 hunks)content/SDKs/javascript/api-reference.mdx(0 hunks)content/SDKs/javascript/core-concepts.mdx(0 hunks)content/SDKs/javascript/examples/index.mdx(1 hunks)content/SDKs/javascript/frameworks.mdx(1 hunks)content/SDKs/javascript/index.mdx(2 hunks)content/SDKs/javascript/meta.json(1 hunks)content/SDKs/javascript/troubleshooting.mdx(1 hunks)content/SDKs/python/api-reference.mdx(0 hunks)content/SDKs/python/examples/index.mdx(0 hunks)content/SDKs/python/examples/pydantic.mdx(1 hunks)content/SDKs/python/frameworks.mdx(1 hunks)content/SDKs/python/index.mdx(2 hunks)content/SDKs/python/meta.json(1 hunks)content/docs/SDKs/python/agent-to-agent.mdx(0 hunks)content/docs/SDKs/python/index.mdx(0 hunks)content/meta.json(1 hunks)package.json(2 hunks)public/_headers(1 hunks)
💤 Files with no reviewable changes (13)
- content/Changelog/sdk-py.mdx
- content/Changelog/sdk-js.mdx
- content/SDKs/python/api-reference.mdx
- content/SDKs/python/examples/index.mdx
- content/SDKs/javascript/core-concepts.mdx
- content/Integrations/index.mdx
- content/Integrations/sms.mdx
- content/docs/SDKs/python/index.mdx
- content/docs/SDKs/python/agent-to-agent.mdx
- content/SDKs/javascript/api-reference.mdx
- content/Integrations/slack.mdx
- components/Code.tsx
- content/Integrations/webhooks.mdx
🧰 Additional context used
🧬 Code Graph Analysis (4)
app/(docs)/layout.tsx (2)
app/layout.config.tsx (1)
baseOptions(10-57)lib/source.ts (1)
source(5-8)
components/Community.tsx (1)
components/NavButton.tsx (2)
NavButtonProps(3-8)NavButton(9-29)
app/(docs)/[[...slug]]/page.tsx (2)
components/Community.tsx (1)
CommunityButton(3-28)components/XButton.tsx (1)
XButton(4-34)
app/layout.config.tsx (3)
components/NavButton.tsx (1)
NavButton(9-29)components/Community.tsx (1)
CommunityButton(3-28)components/XButton.tsx (1)
XButton(4-34)
🪛 LanguageTool
content/Changelog/cli.mdx
[grammar] ~612-~612: The operating system from Apple is written “macOS”.
Context: ...entuity/cli/pull/182)) - Fixed: Fix MacOS segfault during reinstallation ([#183](...
(MAC_OS)
content/Guides/agent-engineering.mdx
[style] ~58-~58: If you’re making a request, consider inserting ‘please’ to sound more courteous and respectful.
Context: ...r input in traditional apps. ---- ### Can you show me a practical example of the diff...
(CAN_YOU)
content/Cloud/aigateway.mdx
[uncategorized] ~32-~32: When ‘provider-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...erride using the AI Gateway, use the AI provider specific environment variables to configure them...
(SPECIFIC_HYPHEN)
content/CLI/env.mdx
[style] ~65-~65: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ng` - The format to use for the output. Can be either 'text' or 'json' (default "te...
(MISSING_IT_THERE)
[style] ~85-~85: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ng` - The format to use for the output. Can be either 'text' or 'json' (default "te...
(MISSING_IT_THERE)
content/Guides/what-is-an-agent.mdx
[misspelling] ~6-~6: This word is normally spelled as one.
Context: ...ent --- > But aren't agents just smart chat bots? 🤖 ## Understanding the Difference Be...
(EN_COMPOUNDS_CHAT_BOTS)
[style] ~24-~24: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ...y contrast, are autonomous actors. They have the ability to decide how to achieve a goal, not just ...
(HAS_THE_ABILITY_TO)
[uncategorized] ~30-~30: If “ what” starts an indirect question, you do not need to put a comma before it.
Context: ...different actions based on what it knows, what it's learned, or what it perceives in r...
(NO_COMMA_BEFORE_INDIRECT_QUESTION)
[grammar] ~67-~67: The verb ‘compute’ does not usually follow articles like ‘the’. Check that ‘compute’ is spelled correctly; using ‘compute’ as a noun may be non-standard.
Context: ...mized cloud computing largely by moving the compute to the edge, focusing on horizontal sca...
(A_INFINITIVE)
[uncategorized] ~71-~71: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ed globally. Enter agents: Agents demands a new paradigm. Agents aren't focused ...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~71-~71: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s, they are stateful and both short and long term memory is required. They are not distr...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~77-~77: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...d). ---- If you're a software engineer and you need to build agents, you need to t...
(COMMA_COMPOUND_SENTENCE)
content/CLI/project.mdx
[style] ~23-~23: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ng` - The format to use for the output. Can be either 'text' or 'json' (default "te...
(MISSING_IT_THERE)
content/Guides/agent-native-cloud.mdx
[misspelling] ~8-~8: This word is normally spelled as one.
Context: ...that were built for humans or stateless micro-services, an agent-native cloud gives them nativ...
(EN_COMPOUNDS_MICRO_SERVICES)
[misspelling] ~107-~107: This word is normally spelled as one.
Context: ...Developers* – Focus on behaviour, not boiler-plate. Agentuity gives you SDKs, simulators, ...
(EN_COMPOUNDS_BOILER_PLATE)
[style] ~109-~109: Consider using a different verb for a more formal wording.
Context: ...Fewer 3 AM pages. Self-healing routines fix issues in seconds and leave an explaina...
(FIX_RESOLVE)
content/CLI/cloud.mdx
[grammar] ~56-~56: The word “rollback” is a noun. The verb is spelled with a white space.
Context: ...lback - --project string - Project to rollback a deployment - --tag string - Tag of ...
(NOUN_VERB_CONFUSION)
[grammar] ~66-~66: This sentence should probably be started with a verb instead of the noun ‘Rollback’. If not, consider inserting a comma for better clarity.
Context: ...rolled back successfully Rollback a project to a specific tag: <CLIComma...
(SENT_START_NN_DT)
content/Introduction/index.mdx
[grammar] ~56-~56: The operating system from Apple is written “macOS”.
Context: ...Cloud. It supports Windows (using WSL), MacOS, and Linux. <CLICommand command="curl ...
(MAC_OS)
[typographical] ~72-~72: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...p if you used the CLI to sign up for an account, otherwise you must login to your account using th...
(THUS_SENTENCE)
[misspelling] ~72-~72: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...n up for an account, otherwise you must login to your account using the CLI. <CLICom...
(LOG_IN)
[style] ~79-~79: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... ### Create Your First Project You can select a template to get started qu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~87-~87: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ep> ### Run Your Agent Locally You can run your agent locally to test it o...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/CLI/installation.mdx
[grammar] ~7-~7: The operating system from Apple is written “macOS”.
Context: ...hat can be used on Windows (using WSL), MacOS, and Linux. ### Install Script The ea...
(MAC_OS)
[grammar] ~11-~11: The word ‘install’ is not a noun.
Context: ...install the Agentuity CLI is to use the install script. This script will automatically ...
(A_INSTALL)
[grammar] ~65-~65: The operating system from Apple is written “macOS”.
Context: ...cally set up for: - Bash and Zsh on MacOS and Linux (when you have write permissi...
(MAC_OS)
content/Cloud/agents.mdx
[uncategorized] ~14-~14: You might be missing the article “an” here.
Context: ...inputs and outputs, recent sessions and overview of costs. <ThemeImage baseName="agent-...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~63-~63: Check that the noun ‘agent’ after the pronoun ‘you’ is correct. It’s possible that you may need to switch to a possessive pronoun, or use another part of speech.
Context: ...nt-io-new" alt="Agent New IO" /> When you agent is invoked, it will process the data an...
(PRP_VB)
[style] ~133-~133: Try using a more formal synonym here to elevate your writing.
Context: ...cation values for each agent. When you plan on using the API source, it is recommended that ...
(PLAN_ON_INTEND)
[style] ~219-~219: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-tag` flag. The active deployment will only be used for agent requests based on the...
(ONLY_EXCLUSIVELY_STYLE)
[misspelling] ~229-~229: Did you mean “to”?
Context: ...make it the active deployment. You can the invoke the agent with the v1.0.0 tag ...
(THE_TO)
[grammar] ~239-~239: The word “rollback” is a noun. The verb is spelled with a space.
Context: ...llout> #### Rollback & Delete You can rollback to a previous deployment by using the C...
(NOUN_VERB_CONFUSION)
[uncategorized] ~267-~267: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...cific session, you can view the session detail for the specific session. <ThemeImage ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
content/Guides/agent-communication.mdx
[style] ~14-~14: ‘overall goal’ might be wordy. Consider a shorter alternative.
Context: ...t-to-agent communication to achieve the overall goal. There are a number of ways to achieve...
(EN_WORDINESS_PREMIUM_OVERALL_GOAL)
[uncategorized] ~42-~42: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...rk. #### Communication Methods Agents has two primary methods of communication wi...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[grammar] ~46-~46: The word “handoff” is a noun. The verb is spelled with a space.
Context: ...-|-------------| | Handoff | Agents can handoff a request to another agent to complete ...
(NOUN_VERB_CONFUSION)
[grammar] ~51-~51: The word “handoff” is a noun. The verb is spelled with a space.
Context: ... ##### Handoff When an agent needs to handoff a request to another agent, it can do s...
(NOUN_VERB_CONFUSION)
[grammar] ~53-~53: You can use the subjunctive mood in this context.
Context: ...t and can complete the request as if it was the original request. A trivial exampl...
(SUBJUNCTIVE_MOOD)
[grammar] ~71-~71: You can use the subjunctive mood in this context.
Context: ...t and can complete the request as if it was the original request. Calling another ...
(SUBJUNCTIVE_MOOD)
[grammar] ~75-~75: You can use the subjunctive mood in this context.
Context: ...t and can complete the request as if it was the original request. Since we are pass...
(SUBJUNCTIVE_MOOD)
[uncategorized] ~132-~132: Possible missing comma found.
Context: ...es to the target agent and wait for the result and then use the result in your own age...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~191-~191: This word is normally spelled with a hyphen.
Context: ...d. | | Agent Name | The agent name is a human readable name for an agent. It is a string that...
(EN_COMPOUNDS_HUMAN_READABLE)
[misspelling] ~196-~196: This word is normally spelled with a hyphen.
Context: ... the target agent. The agent name is a human readable name for an agent. It is a string that...
(EN_COMPOUNDS_HUMAN_READABLE)
content/Introduction/templates.mdx
[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ity Template system is fully open source and you can create your own templates by fo...
(COMMA_COMPOUND_SENTENCE)
content/CLI/version.mdx
[grammar] ~92-~92: The operating system from Apple is written “macOS”.
Context: ...to version 0.0.139. > On MacOS, if the CLI was installed using Homebre...
(MAC_OS)
content/Guides/agent-streaming.mdx
[uncategorized] ~43-~43: A comma might be missing here.
Context: ... client's incoming stream. 3. Under the hood Agentuity handles the details of the st...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Workers Builds: docs
🔇 Additional comments (115)
.gitignore (1)
32-33: Approve ignoring generated docs JSON.
Excludingcontent/docs.jsonwith a clarifying comment is exactly what we want to keep build artifacts out of version control.content/Guides/.agent-telemetry.mdx (1)
1-4: Valid frontmatter metadata
The new MDX file correctly includes thetitleanddescriptionfields in the frontmatter, matching the pattern of your other guides.content/meta.json (1)
4-6: Approve insertion of "Guides" in site navigation.The new
"Guides"entry is correctly placed after"Introduction"and before"Cloud", matching the addition of thecontent/Guides/section in this PR.content/Guides/.security.mdx (1)
1-4: Frontmatter is valid and integrates the new Security Guide.The metadata is correctly formatted and will register the guide under the navigation.
content/Guides/.agent-patterns.mdx (1)
1-4: Frontmatter for Agent Patterns guide is correct.Title and description align with the guide’s purpose and will integrate smoothly into the documentation.
content/Guides/.agent-data-handling.mdx (1)
1-4: Frontmatter for Agent Data Handling guide is properly defined.Metadata is formatted correctly and will register the new guide in the navigation.
content/Introduction/meta.json (1)
2-4: Introduction section pages list updated correctly.Explicitly listing
["index", "architecture", "templates"]improves navigation clarity and completeness.content/Cloud/meta.json (1)
1-12: LGTM! Well-structured navigation metadata.The JSON configuration is properly formatted and provides a logical organization for the Cloud Console documentation sections.
content/Guides/.devmode.mdx (1)
1-4: Approve frontmatter for new DevMode guide
The frontmatter metadata is correctly defined and consistent with other Guides.content/Changelog/index.mdx (1)
8-10: Approve addition of GitHub repository links
The external links to the CLI, JavaScript SDK, and Python SDK repos are accurate and improve discoverability.content/CLI/meta.json (1)
2-4: Verify placeholder usage in pages list
The"pages": ["installation", "..."]entry includes an ellipsis placeholder. Confirm if this is intentional or replace it with the actual page identifiers to avoid navigation gaps.content/Guides/.agent-tracing.mdx (1)
1-4: Approve frontmatter for new Agent Tracing guide
The metadata follows established conventions and is ready for further content authoring.content/SDKs/javascript/examples/index.mdx (1)
544-544: Consistent CLI command rendering
Good replacement of the raw code block with the<CLICommand>component to standardize installation instructions across the JavaScript SDK docs.content/Cloud/organization.mdx (2)
1-4: Frontmatter configuration is valid
Thetitleanddescriptionfields align with other Cloud Console pages and provide clear metadata.
10-10: Verify the accompanying image asset
Ensure that thesettings-orgimage file (e.g.,settings-org.pngorsettings-org.svg) exists under the project’s public assets (and dark-mode variant if required) so that<ThemeImage>renders correctly.app/(docs)/layout.tsx (2)
5-5: Add explicitchildrentype annotation
IntroducingReactNodefor thechildrenprop enhances type safety and readability of the layout component.
9-9: SimplifyDocsLayoutprops
SpreadingbaseOptionsand passingtree={source.pageTree}directly removes the unused sidebar customization, streamlining the layout configuration.public/_headers (1)
1-2: Implement long-term caching for static assets
TheCache-Control: public,max-age=31536000,immutabledirective correctly instructs browsers to cache Next.js static files for one year, improving performance and reducing bandwidth.content/Cloud/api-keys.mdx (1)
2-3: Looks good! The title and description are clear and consistent.package.json (2)
21-23: Dependencies additions look correct. The newgeist,mermaid, andmotionpackages align with the recently introduced React components (GeistSans,Mermaid,TypingAnimation) and are properly versioned.
30-31: Verify major version upgrade compatibility.
You've bumped@opennextjs/cloudflarefrom^0.6.6to^1.0.4, which is a breaking change. Please confirm that this upgrade is compatible with your Next.js version and the Cloudflare Workers setup.app/layout.tsx (1)
2-2: LGTM! Font and theme improvements look good.The changes effectively:
- Migrate to the
geistpackage for better font handling- Enable comprehensive theme support with system detection
- Streamline the font className application
These updates align well with the V2 documentation enhancements and provide a solid foundation for the new theming capabilities.
Also applies to: 8-8, 10-12
content/CLI/mcp.mdx (2)
3-3: Good content improvements for clarity.The description updates and additional information about automatic MCP server installation help users understand the setup process better.
Also applies to: 6-6, 9-9
19-19: Excellent standardization with CLICommand component.Converting all CLI command examples to use the custom
<CLICommand>component provides consistent styling and presentation across the documentation. This change aligns with the broader documentation formatting improvements in this PR.Also applies to: 25-27, 33-33, 38-38, 44-44, 49-49, 55-55, 61-61, 67-67
content/Guides/meta.json (1)
1-13:✅ Verification successful
Verify the ellipsis entry in the pages array.
The metadata structure looks good for organizing the Guides section navigation. However, the
"..."entry on line 7 needs verification.Please confirm whether the
"..."entry is:
- An intentional separator/grouping element supported by your documentation system
- A placeholder that should be replaced with actual guide page identifiers
🏁 Script executed:
#!/bin/bash # Check if there are additional guide files that should be listed in meta.json echo "Checking for guide files in content/Guides directory:" fd -e mdx -e md . content/Guides/ 2>/dev/null || echo "content/Guides directory not found" echo -e "\nChecking if '...' is used in other meta.json files:" fd meta.json . | xargs grep -l "\.\.\." 2>/dev/null || echo "No other meta.json files contain '...'"Length of output: 623
Ellipsis as Intentional Separator
The
...entry in content/Guides/meta.json is used consistently as a visual/grouping separator across our navigation metadata (also found in content/CLI/meta.json, content/SDKs/javascript/meta.json, and content/SDKs/python/meta.json). This is an intentional convention supported by our documentation system—no replacement or removal is needed.app/(docs)/[[...slug]]/page.tsx (3)
1-7: Well-organized component imports for enhanced documentation features.The new UI component imports provide comprehensive functionality including CLI commands, code examples, diagrams, and interactive elements. The import organization is clean and follows good practices.
Also applies to: 19-20
52-62: Excellent MDX component integration.The extension of MDX components with the new UI elements provides rich interactive documentation capabilities. The replacement of
CodewithCodeExamplesuggests enhanced code presentation with tabbed examples as mentioned in the summary.
64-83:✅ Verification successful
Valuable "Need Help?" section enhances user support.
The help section provides multiple support channels and uses the imported components effectively. The styling with margin, border, and background creates good visual separation.
Please verify the external links for correctness:
🏁 Script executed:
#!/bin/bash # Verify the email and signup links are accessible echo "Checking if signup link is accessible:" curl -Is "https://app.agentuity.com/sign-up" | head -1 echo -e "\nChecking if email format is valid:" echo "hi@agentuity.com" | grep -E '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$' && echo "Email format is valid" || echo "Email format is invalid"Length of output: 394
External support links verified and valid
The “Need Help?” section effectively offers multiple support channels and is styled for clear visual separation. Verification results:
- Signup link (
https://app.agentuity.com/sign-up): HTTP/2 200 OK- Email address (
hi@agentuity.com): valid formatNo further changes required.
content/SDKs/javascript/index.mdx (1)
12-53: Review all<CLICommand>replacements for accuracyMultiple CLI examples were migrated to
<CLICommand>. Please verify:
- Each
commandprop matches the intended text (e.g.,agentuity createvs.agentuity new).- Multi-line commands use proper escaping and indentation in MDX.
- No residual code fences remain.
This will ensure consistency and prevent rendering errors.
content/CLI/agent.mdx (3)
3-3: Clarify description changeThe frontmatter
descriptionwas shortened to “Commands for managing agents.” Confirm that dropping “in your Agentuity project” doesn’t remove critical context for first-time users.
16-16: Validate<CLICommand>usage patternsVerify that the self-closing
<CLICommand>tags are used for single-line commands, and open/close tags handle interactive examples or outputs as intended by the component API.Also applies to: 52-52, 84-84, 114-114
149-149: Approve default path quotingThe default config path is now wrapped in backticks. This matches typical Markdown style for inline code and is consistent with
--log-level.content/SDKs/python/index.mdx (1)
12-12: Review<CLICommand>integration across Python SDK docsAll CLI instructions should mirror their JavaScript counterparts. Confirm proper replacement of raw code blocks with:
agentuity createcurl -LsSf https://astral.sh/uv/install.sh | shagentuity devuv run server.py- Multi-line
curl -v http://localhost:3500/agent_ID ...Verify correct escaping and that no old fences remain.
Also applies to: 30-30, 38-38, 44-44, 48-48
content/CLI/dev.mdx (3)
3-3: Good improvement to emphasize DevMode in the description.The updated description clearly communicates that this command is specifically for local development using DevMode, which helps users understand the context better.
16-16: Excellent use of the CLICommand component for consistency.The conversion from raw code blocks to the
<CLICommand>component provides a more consistent and interactive documentation experience. This standardizes command rendering across the CLI documentation.Also applies to: 27-29, 33-35
37-37: Good addition of the DevMode guide reference.Linking to the DevMode guide provides users with additional context and detailed instructions, improving the overall documentation experience.
components/NavButton.tsx (2)
3-8: Well-defined TypeScript interface with clear prop names.The interface clearly defines the expected props with appropriate types and optional properties. The naming is intuitive and follows React conventions.
18-24: Good use of conditional styling with the cn utility.The className composition logic is clean and readable. The conditional styling based on the
noBorderprop provides good flexibility for different use cases while maintaining consistent styling defaults.content/Cloud/aigateway.mdx (2)
8-8: Good use of ThemeImage component for responsive documentation images.The ThemeImage components will provide proper theming support and responsive behavior for the documentation images, enhancing the user experience across different devices and themes.
Also applies to: 26-26
42-44: Excellent use of callout for important information.The callout provides helpful context about provider-specific API key setup, guiding users to consult appropriate documentation.
components/XButton.tsx (3)
4-12: Clean TypeScript prop definition with good defaults.The props interface is well-defined with sensible defaults. The optional props provide flexibility for different use cases.
20-31: Excellent SVG accessibility implementation.The SVG includes proper accessibility attributes (
aria-hidden="true",aria-label="X", and<title>) ensuring the component is accessible to screen readers and other assistive technologies.
14-18: Good reuse of NavButton component for consistency.Extending the NavButton component ensures consistent styling and behavior across navigation elements while adding X-specific functionality.
content/CLI/bundle.mdx (2)
16-16: Excellent use of the new CLICommand component.The adoption of the
<CLICommand>component provides consistent styling and presentation across CLI documentation.
19-24:❓ Verification inconclusive
Verify flag descriptions are accurate.
Please ensure the new
--deployand--installflags are actually supported by the bundle command and that their descriptions accurately reflect their behavior.
🏁 Script executed:
#!/bin/bash # Description: Verify bundle command flags are accurately documented # Expected: Find bundle command implementation and confirm flag support # Search for bundle command implementation ast-grep --pattern 'func $_ bundle($$$) { $$$ }' # Also search for flag definitions related to bundle rg -A 5 -B 5 "deploy.*flag|install.*flag" --type go --type js --type tsLength of output: 126
I couldn’t locate the bundle command or its flags with the previous patterns. Let’s broaden our search to find where “bundle” is defined and verify the
--deployand--installflags:
🏁 Script executed:
#!/bin/bash # 1. List any files with "bundle" in their name echo "=== Files named *bundle* ===" fd -t f bundle # 2. Search for Go/Cobra definitions of the bundle command echo -e "\n=== Go cobra 'bundle' command definitions ===" rg --type go 'Use:\s*"bundle"' -A3 # 3. Search for JS/TS CLI definitions of the bundle command echo -e "\n=== JS/TS .command('bundle') definitions ===" rg --type js --type ts "command\(\s*['\"]bundle['\"]" -A3 # 4. Search for flag registration of install/deploy echo -e "\n=== Flag registration for install/deploy ===" rg --type go 'Flag.*install' -A3 rg --type go 'Flag.*deploy' -A3 rg --type js --type ts 'option\(\s*["'\"'].*install' -A3 rg --type js --type ts 'option\(\s*["'\"'].*deploy' -A3Length of output: 1163
Confirm CLI flags
--deployand--installI wasn’t able to find the
bundlecommand implementation or any registrations for--deployand--installin the codebase. Please double-check the actual CLI code to ensure:
- The
--deployflag is implemented on thebundlecommand and behaves as described (deploys after bundling).- The
--installflag exists and installs dependencies before bundling.File:
content/CLI/bundle.mdx
Lines: 19–24content/Cloud/index.mdx (1)
14-21: Well-organized service categorization.The new "Agentic Services" section provides clear categorization and improved readability compared to the previous structure.
content/CLI/apikey.mdx (2)
14-22: Consistent and improved CLI documentation formatting.The use of
<CLICommand>components and comprehensive examples greatly improves the documentation quality and consistency.
32-76:❓ Verification inconclusive
Comprehensive flag documentation added.
The detailed flag documentation across all apikey subcommands provides excellent reference material for users. Ensure all documented flags are actually supported by the implementation.
🏁 Script executed:
#!/bin/bash # Description: Verify apikey command flags match documentation # Expected: Find apikey command implementation and confirm flag support # Search for apikey command definitions ast-grep --pattern 'func $_ apikey($$$) { $$$ }' # Search for flag definitions in apikey commands rg -A 3 -B 3 "expires-at|format|org-id|project-id|mask" --type go --type js --type tsLength of output: 497
🏁 Script executed:
#!/bin/bash # Locate Cobra definitions for all apikey subcommands rg -n 'Use:.*"apikey' --type go # Verify each documented flag is actually registered in code for flag in "expires-at" "format" "org-id" "project-id" "mask"; do echo "Searching for flag: $flag" rg -n "\"$flag\"" --type go || echo "⚠️ No occurrences of \"$flag\" found" doneLength of output: 2147
#!/bin/bash # Search for documented flags across the entire repo (no type filter) for flag in "expires-at" "format" "org-id" "project-id" "mask"; do echo -e "\n🔍 Looking for “--$flag”" rg -n "\-\-$flag" || echo "⚠️ Not found: --$flag" done # Locate all cobra Command definitions that mention “apikey” echo -e "\n🔍 Locating cobra.Command Use: fields for apikey subcommands" rg -n 'Use:.*apikey' -g '*.go' || echo "⚠️ No cobra Use: containing “apikey” found"
#!/bin/bash # 1. Locate apikey command constructors (e.g., newApikeyCmd, newApikeyCreateCmd, etc.) echo "🔍 Searching for apikey command constructors:" rg -n "func new.*Apikey.*Cmd" -g '*.go' || echo "⚠️ No apikey constructors found" # 2. Gather all files that register flags (StringVar, StringVarP, BoolVarP, etc.) flag_files=$(rg -lE 'Flags\(\)\.(StringVarP|StringVar|BoolVarP|BoolVar)' -g '*.go') if [[ -z "$flag_files" ]]; then echo "⚠️ No flag registration calls found in Go files." exit 0 fi echo -e "\n🔍 Inspecting flag registrations for documented flags:" for file in $flag_files; do echo -e "\n==> $file" rg -nE 'StringVarP|StringVar|BoolVarP|BoolVar' "$file" \ | grep -E '"(expires-at|format|org-id|project-id|mask)"' \ || echo " ⚠️ No documented flags in this file" done
Confirm CLI flag support for all apikey subcommands
We’ve added detailed flag docs for
create,delete,get, andlist. Please verify that each documented flag is actually registered in the CLI implementation:• apikey create
– --expires-at
– --format
– -o, --org-id
– -p, --project-id• apikey delete
– none beyond the default id argument• apikey get
– --format
– -m, --mask• apikey list
– --format
– -m, --mask
– -o, --org-id
– -p, --project-idIf any flags are missing or named differently in code, please update the docs or implementation accordingly.
app/layout.config.tsx (3)
40-56: Excellent navigation component integration.The new custom links structure using React components provides a much more interactive and maintainable navigation system compared to static links.
2-5:✅ Verification successful
Verify new component imports are correctly implemented.
The new navigation button components look well-integrated. Please ensure these components are properly exported from their respective files and follow consistent patterns.
🏁 Script executed:
#!/bin/bash # Description: Verify all imported components exist and are properly exported # Expected: Find component definitions with proper exports # Check component files exist and have proper exports for component in "NavButton" "CommunityButton" "XButton"; do echo "Checking component: $component" fd -t f "$component.tsx" components/ rg -A 3 "export.*$component" components/ doneLength of output: 1405
Imports Verified: All Custom Button Components Properly Exported
All three navigation components are present in
components/and export their respective functions correctly:
components/NavButton.tsxexportsNavButtoncomponents/Community.tsxexportsCommunityButtoncomponents/XButton.tsxexportsXButtonNo further changes required.
10-10:✅ Verification successful
Verify removal of githubUrl doesn't break existing functionality.
The
githubUrlproperty was removed frombaseOptions. Please ensure this property isn't referenced elsewhere in the codebase, particularly in fumadocs-ui components that might expect it.
🏁 Script executed:
#!/bin/bash # Description: Check if githubUrl is referenced elsewhere in the codebase # Expected: Find any remaining references to githubUrl # Search for githubUrl references rg -i "githuburl" --type tsx --type ts --type js --type jsx # Also check in package.json and config files rg -i "githuburl" --type jsonLength of output: 117
🏁 Script executed:
#!/bin/bash # Re-run search for any references to the removed `githubUrl` property # without restricting by file type, to ensure we catch all instances. # 1. Search across all files for exact property name rg -n "githubUrl" # 2. As a fallback, grep across hidden and non-hidden files grep -R -n "githubUrl" .Length of output: 42
No references to
githubUrlfound – removal is safe.
A full-text search across the repository (including hidden files) returned no instances of the removedgithubUrlproperty. Removing it frombaseOptionsinapp/layout.config.tsxwill not break existing functionality.content/CLI/auth.mdx (3)
3-3: LGTM: Good terminology simplificationThe change from "Agentuity Cloud Platform" to just "Agentuity" in the description makes the documentation more concise while maintaining clarity.
16-16: LGTM: Excellent use of CLICommand componentThe adoption of the
<CLICommand>component throughout the documentation provides consistent formatting and improved presentation of CLI commands and their outputs. This standardization enhances the documentation's visual consistency and user experience.Also applies to: 24-26, 36-36, 42-44, 54-54, 58-68
20-20:❓ Verification inconclusive
Verify the config file format change
The configuration file path changed from
.jsonto.yaml. Please ensure this aligns with the actual CLI implementation and that the change is consistently documented across all relevant files.
🏁 Script executed:
#!/bin/bash # Check for any remaining references to the old .json config path rg "config\.json" --type mdLength of output: 29
🏁 Script executed:
#!/bin/bash # Search entire repository for any references to the old JSON config rg -n "config\.json" # Search for YAML config references to confirm new path usage rg -n "config\.yaml"Length of output: 395
Confirm CLI implementation uses YAML for config file
I searched the docs and found that the default path has been updated to
.yamlin the following files, with no remaining.jsonreferences in MDX files:• content/CLI/auth.mdx (line 20) – default set to
$HOME/.config/agentuity/config.yaml
• content/CLI/agent.mdx (line 149) – help text updated to.yamlPlease verify that the CLI’s codebase—including the default-path constant, parsing logic, test suites, and any examples—has likewise been updated to use
$HOME/.config/agentuity/config.yaml(YAML) and that there are no lingering JSON-based config references or parsers.content/Guides/agent-engineering.mdx (1)
1-132: LGTM: Excellent comprehensive guide on agent engineeringThis is a well-structured and informative guide that effectively communicates the paradigm shift from traditional software engineering to agent-based development. The content flows logically from conceptual understanding to practical examples, making it accessible to engineers new to agent development.
Key strengths:
- Clear mindset shift explanations with actionable tips
- Practical JSON transformation example that demonstrates the power of agentic approaches
- Good use of formatting and callouts for emphasis
- Comprehensive coverage of key concepts
🧰 Tools
🪛 LanguageTool
[style] ~58-~58: If you’re making a request, consider inserting ‘please’ to sound more courteous and respectful.
Context: ...r input in traditional apps. ---- ### Can you show me a practical example of the diff...(CAN_YOU)
content/CLI/version.mdx (1)
16-16: LGTM: Consistent adoption of CLICommand componentExcellent work standardizing the CLI documentation with the
<CLICommand>component. The examples are clear and the formatting is consistent with the broader documentation update.Also applies to: 25-27, 30-34, 42-42, 52-54, 57-60, 68-68, 79-84, 87-90
content/Cloud/vector-memory.mdx (4)
2-3: LGTM: Good title and section heading simplificationThe change from "Vector Memory Storage" to "Vector Storage" makes the documentation more concise while maintaining clarity.
Also applies to: 6-6
37-37: Good navigation path correctionThe update from "Memory > Vector" to "Services > Vector" appears to align with UI restructuring. Please ensure this matches the actual navigation in the Cloud Console.
25-25: Excellent addition of theme-aware imagesThe integration of
<ThemeImage>components enhances the documentation with visual aids that adapt to the user's theme preference. This significantly improves the user experience.Also applies to: 31-31, 40-40
27-31: Good addition of vector data management sectionThe new "View Vector Data" section provides valuable information about data management capabilities, improving the completeness of the documentation.
components/ThemeImage.tsx (1)
1-42: LGTM: Well-implemented theme-aware image componentThe component provides good theme-aware functionality with proper state management and loading states. The integration with
react-medium-image-zoomadds nice UX for image viewing.Key strengths:
- Proper use of
useThemehook for theme detection- Good loading state handling with transparent placeholder
- Clean separation of concerns with separate effects for loading and theme changes
- Appropriate ESLint disable for this specific use case
content/Cloud/project.mdx (1)
1-61: Excellent documentation structure and security awareness!This comprehensive project documentation effectively covers all essential aspects of project management including environment variables, API keys, and CLI usage. The security warnings about
.envfiles and the clear distinction between development and production environments demonstrate good security practices.content/Cloud/key-value-memory.mdx (2)
2-3: Good consistency improvement!The title change from "Key-Value" to "Key Value" maintains consistency across the documentation.
38-38: Navigation path correction is important.Updating the path from "Memory > Key-Value" to "Services > Key Value" aligns with the broader documentation reorganization mentioned in the AI summary.
content/Examples/index.mdx (2)
10-16: Systematic styling improvements for better consistency.The updated anchor styling with
bg-fd-secondaryand simplified classes creates a more consistent user experience across all GitHub links.
37-43: Consistent application of new styling pattern.The margin adjustments (
mb-14) and unified styling approach improve visual consistency throughout the examples page.content/CLI/env.mdx (8)
3-3: Description updated correctly
The updated description succinctly reflects the scope of theenvcommands without unnecessary references.
29-37: Examples leverage<CLICommand>correctly
The usage examples forenv setare now rendered with<CLICommand>and match the expected command patterns.
41-43: File-based example formatting is consistent
The<CLICommand>wrapping for the file import example is correctly applied.
49-51: Security warning callout is clear
The new error callout effectively highlights best practices around handling secrets.
69-73: List command example is correctly updated
Theenv listexample uses<CLICommand>and shows output as expected.
89-93: Get command example formatting is correct
Theenv getexample is now wrapped in<CLICommand>as expected.
99-107: Delete command usage and flags are clear
Theenv deleteusage, aliases, and flags are consistently formatted and accurate.
113-121: Delete examples render correctly
The single and multi-variable deletion examples use<CLICommand>correctly and display expected outputs.content/CLI/project.mdx (7)
3-3: Description is concise and accurate
The updated description clearly summarizes the scope of theprojectcommands.
12-12: Alias formatting forproject createis consistent
Using**Aliases:** create, newfollows the established pattern from other CLI docs.
34-37: Project creation example is well formatted
The example uses<CLICommand>appropriately and matches the expected output.
42-47: Project list alias and usage are correct
**Aliases:** lsand the<CLICommand>invocation forproject listfollow the new component pattern.
50-55: Project list example is displayed properly
The example block correctly wraps the command and its output within<CLICommand>.
86-95: Project import description, usage, and flags are accurate
The section clearly explains import, shows the<CLICommand>invocation, and lists flags correctly.
99-101: Project import example is well formatted
The example demonstrates the import command and expected output as intended.content/CLI/cloud.mdx (8)
3-3: Description accurately reflects command scope
The new description clarifies that these commands manage agents.
12-12: Alias notation forcloud deployis correct
Using**Aliases:** deployaligns with other CLI documentation.
16-16: Usage component integration is consistent
The<CLICommand>wrapper foragentuity cloud deployrenders usage uniformly.
19-27: Flag list for deploy is comprehensive and clear
All new flags (--description,--force,--format, etc.) are documented with types and defaults.
33-41: Deploy examples follow the correct pattern
Both default and directory-specific deploy examples are properly wrapped in<CLICommand>and display expected outputs.
43-47: Rollback section introduction is clear
The description "Rolls back a project to a previous version." and heading update are accurate.
49-58: Rollback flags are complete and well formatted
All rollback flags (--delete,--dir,--force,--project,--tag) are listed with descriptions.🧰 Tools
🪛 LanguageTool
[grammar] ~56-~56: The word “rollback” is a noun. The verb is spelled with a white space.
Context: ...lback ---project string- Project to rollback a deployment ---tag string- Tag of ...(NOUN_VERB_CONFUSION)
63-77: Rollback examples demonstrate functionality
All three rollback scenarios (default, tag-specific, delete) are shown with<CLICommand>wrapping and correct outputs.🧰 Tools
🪛 LanguageTool
[grammar] ~66-~66: This sentence should probably be started with a verb instead of the noun ‘Rollback’. If not, consider inserting a comma for better clarity.
Context: ...rolled back successfully Rollback a project to a specific tag: <CLIComma...(SENT_START_NN_DT)
app/global.css (1)
34-53: CSS custom property additions are consistent and comprehensive. The new--color-fd-*variables and dark mode overrides align well with the updated UI components and enable the intended theming.content/SDKs/javascript/frameworks.mdx (5)
10-12: Framework list update looks correct
The new entries for LangChain and Mastra are well-formatted and ordered alphabetically with Vercel AI SDK.
16-18: Consistent CLI command formatting
Switching fromagentuity newto<CLICommand command="agentuity create" />aligns with the updated CLI docs.
22-67: Vercel AI SDK example is clear and accurate
The imports, function signature, prompt handling, intent classification withgenerateObject, and routing logic all look correct and consistent with the Anthropic model usage.
69-114: Mastra example is well-structured
The Agent instantiation, instruction prompt,.generate()call, and handoff logic correctly demonstrate intent-based routing.
116-161: LangChain example follows the same routing pattern
Reusing the MastraAgentclass for intent classification is intentional per documentation. The code snippet is consistent and self-contained.content/Guides/agent-communication.mdx (1)
1-4: Frontmatter and metadata are set correctly
The title, description, and import of theImagecomponent establish the new guide.content/SDKs/python/frameworks.mdx (7)
11-14: Supported framework list updated
LangChain, LlamaIndex, and the new Pydantic entry are correctly listed alongside CrewAI.
17-19: CLI command example updated
Using<CLICommand command="agentuity create" />ensures consistent styling across SDK docs.
23-43: CrewAI example run function is correct
The asyncrunfunction demonstrates prompt extraction, crew kickoff, and text response properly.
45-82: Crew class definition is well detailed
The@CrewBaseclass with@agent,@task, and@crewmethods provides clear guidance on configuring a Concierge crew.
90-124: LangChain example usesChatAnthropiccorrectly
The prompt template, LLM instantiation, parsing, and handoff logic align with the updated intent-classification pattern.
131-158: LlamaIndex workflow example is accurate
TheAnthropicLLM,AgentWorkflow, and routing logic correctly illustrate the pattern.
163-193: Pydantic example integration looks good
Instantiatingpydantic_ai.Agentand routing based onintent_result.outputfollows the new unified pattern.content/Introduction/architecture.mdx (12)
2-4: Frontmatter updated
Title and description now reflect the streamlined “Overview” of Agentuity.
6-14: Overview section clarified
The distinction between long-running agents and container-based runtimes is well explained.
22-30: Agent Platform component expanded
Detailed responsibilities (communication, logging, scaling, services) are clearly articulated.
31-36: Agent Runtime description updated
The new focus on persistent environments and dynamic resource allocation is accurate.
37-43: CLI component mention is accurate
Highlighting MCP integration ensures consistency with external tooling.
43-48: SDKs component expanded
Cross-framework and cross-runtime capabilities are well captured.
59-66: Data Flow section enhanced
Including authenticated, encrypted routing and GitHub Actions support improves clarity.
79-83: Security Architecture refined
Switching to “Agent Isolation” terminology correctly reflects project-level isolation.
101-108: Project conventions are clear
Environment variable definitions for SDK vs project keys are now more explicit.
105-108: Agent Directory description is accurate
Specifying that the agents directory is determined by the runtime removes ambiguity.
114-123: JavaScript project structure updated
Removing the hard-coded agents path in favor ofbundler.agents.dirguidance is helpful.
131-139: Python project structure simplified
Moving agents directly underagents/reflects common Python project layouts.
| --- | ||
| title: Agent Telemetry | ||
| description: How to use telemetry in your agents | ||
| --- |
There was a problem hiding this comment.
Filename begins with a dot – hidden file
Files beginning with . are often treated as hidden and may be ignored by the doc build or your Gitignore rules. Rename this file to agent-telemetry.mdx (remove the leading dot) so the guide is picked up and published.
🤖 Prompt for AI Agents
In content/Guides/.agent-telemetry.mdx at lines 1 to 4, the filename starts with
a dot, making it a hidden file that may be ignored by the documentation build or
Gitignore rules. Rename the file to agent-telemetry.mdx by removing the leading
dot so that the guide is properly detected and published.
| --- | ||
| title: Agent Logging | ||
| description: How to use logging in your agents | ||
| --- |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Critical: Rename file to avoid hidden status
The leading dot in the filename (.agent-logging.mdx) will make this file hidden on most systems and may prevent the static-site generator from discovering the guide.
Please rename the file to remove the leading dot.
- content/Guides/.agent-logging.mdx
+ content/Guides/agent-logging.mdx📝 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.
| --- | |
| title: Agent Logging | |
| description: How to use logging in your agents | |
| --- | |
| - content/Guides/.agent-logging.mdx | |
| + content/Guides/agent-logging.mdx |
🤖 Prompt for AI Agents
In content/Guides/.agent-logging.mdx at lines 1 to 4, the filename starts with a
dot, making it hidden on most systems and likely causing the static-site
generator to skip it. Rename the file to remove the leading dot, for example to
agent-logging.mdx, so it is visible and properly included in the site build.
| --- | ||
| title: Using AI Gateway | ||
| description: Using AI Gateway in your Agents | ||
| --- |
There was a problem hiding this comment.
Rename file to remove leading dot.
Filenames beginning with a dot are treated as hidden and may be ignored by the documentation build process. To ensure this guide is picked up, rename content/Guides/.ai-gateway.mdx to content/Guides/ai-gateway.mdx.
🤖 Prompt for AI Agents
In content/Guides/.ai-gateway.mdx at lines 1 to 4, the filename starts with a
dot, making it hidden and potentially ignored by the documentation build. Rename
the file from .ai-gateway.mdx to ai-gateway.mdx to ensure it is included in the
build process.
| --- | ||
| title: Using Key Value | ||
| description: Using Key Value storage in your Agents | ||
| --- |
There was a problem hiding this comment.
Rename file to remove leading dot.
Hidden file names (starting with .) might not be included in the rendered docs. Please rename content/Guides/.key-value.mdx to content/Guides/key-value.mdx.
🤖 Prompt for AI Agents
In content/Guides/.key-value.mdx lines 1 to 4, the file name starts with a dot,
making it a hidden file that may not be included in the rendered documentation.
Rename the file from ".key-value.mdx" to "key-value.mdx" to ensure it is
properly recognized and rendered in the docs.
| --- | ||
| title: Agent Input and Output | ||
| description: How to handle agent input and output | ||
| --- |
There was a problem hiding this comment.
Rename file to remove leading dot.
The leading dot will hide the file from the build. Rename content/Guides/.agent-io.mdx to content/Guides/agent-io.mdx so it’s published.
🤖 Prompt for AI Agents
In content/Guides/.agent-io.mdx lines 1 to 4, the file name starts with a
leading dot which causes it to be hidden from the build process. Rename the file
by removing the leading dot so it becomes content/Guides/agent-io.mdx to ensure
it is included and published in the build.
|
|
||
| **Enter agents:** | ||
|
|
||
| Agents demands a new paradigm. Agents aren't focused on low latency, they are focused on long-running, complex tasks that require a lot of context and coordination. They are not sessionless, they are stateful and both short and long term memory is required. They are not distributed, they are centralized — often close to the data resources or as close to low latency, high bandwith GPU clusters. |
There was a problem hiding this comment.
Correct subject-verb agreement and hyphenate compound adjective
"Agents demands a new paradigm." should be "Agents demand a new paradigm."
Also hyphenate "long term memory" to "long-term memory".
🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ed globally. Enter agents: Agents demands a new paradigm. Agents aren't focused ...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~71-~71: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s, they are stateful and both short and long term memory is required. They are not distr...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🤖 Prompt for AI Agents
In content/Guides/what-is-an-agent.mdx at line 71, correct the subject-verb
agreement by changing "Agents demands" to "Agents demand" and hyphenate the
compound adjective by changing "long term memory" to "long-term memory".
| description: How we define an Agent | ||
| --- | ||
|
|
||
| > But aren't agents just smart chat bots? 🤖 |
There was a problem hiding this comment.
Fix spelling of “chat bots”
"chat bots" should be one word ("chatbots") to match standard usage.
🧰 Tools
🪛 LanguageTool
[misspelling] ~6-~6: This word is normally spelled as one.
Context: ...ent --- > But aren't agents just smart chat bots? 🤖 ## Understanding the Difference Be...
(EN_COMPOUNDS_CHAT_BOTS)
🤖 Prompt for AI Agents
In content/Guides/what-is-an-agent.mdx at line 6, the phrase "chat bots" should
be corrected to the single word "chatbots" to align with standard spelling
conventions. Replace "chat bots" with "chatbots" in the sentence.
| --- | ||
| title: Agentuity | ||
| title: What is Agentuity? | ||
| description: Agentuity is rebuilding the cloud for AI Agents | ||
| --- | ||
|
|
||
| Agentuity is a cloud platform designed specifically for building, deploying, and scaling | ||
| autonomous AI agents. It provides the infrastructure and tools necessary to manage agents | ||
| built with any framework, such as CrewAI, LangChain, or custom code. | ||
| <div className="text-lg sm:text-xl font-bold h-8 text-cyan-700 dark:text-cyan-300"> | ||
| <TypingAnimation delay={300}>Build agents, not infrastructure</TypingAnimation> | ||
| </div> | ||
|
|
There was a problem hiding this comment.
Imports missing for new MDX components. This file uses <TypingAnimation>, <Callout>, <Cards>, and <Card> components without importing them. Add the necessary imports at the top of the file to avoid runtime errors.
Apply this diff:
---
title: What is Agentuity?
description: Agentuity is rebuilding the cloud for AI Agents
---
+import TypingAnimation from 'components/TypingAnimation';
+import { Callout } from 'fumadocs-ui/components/callout';
+import { Cards, Card } from 'fumadocs-ui/components/cards';📝 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.
| --- | |
| title: Agentuity | |
| title: What is Agentuity? | |
| description: Agentuity is rebuilding the cloud for AI Agents | |
| --- | |
| Agentuity is a cloud platform designed specifically for building, deploying, and scaling | |
| autonomous AI agents. It provides the infrastructure and tools necessary to manage agents | |
| built with any framework, such as CrewAI, LangChain, or custom code. | |
| <div className="text-lg sm:text-xl font-bold h-8 text-cyan-700 dark:text-cyan-300"> | |
| <TypingAnimation delay={300}>Build agents, not infrastructure</TypingAnimation> | |
| </div> | |
| --- | |
| title: What is Agentuity? | |
| description: Agentuity is rebuilding the cloud for AI Agents | |
| --- | |
| import TypingAnimation from 'components/TypingAnimation'; | |
| import { Callout } from 'fumadocs-ui/components/callout'; | |
| import { Cards, Card } from 'fumadocs-ui/components/cards'; | |
| <div className="text-lg sm:text-xl font-bold h-8 text-cyan-700 dark:text-cyan-300"> | |
| <TypingAnimation delay={300}>Build agents, not infrastructure</TypingAnimation> | |
| </div> |
🤖 Prompt for AI Agents
In content/Introduction/index.mdx lines 1 to 9, the components TypingAnimation,
Callout, Cards, and Card are used without importing them, which will cause
runtime errors. Add import statements for these components at the top of the
file to ensure they are properly recognized and avoid errors during rendering.
| <ThemeImage baseName="agent-io-new" alt="Agent New IO" /> | ||
|
|
||
| When you agent is invoked, it will process the data and send the output to the output destination. | ||
|
|
There was a problem hiding this comment.
Fix typo: possessive pronoun. Change "When you agent is invoked" to "When your agent is invoked".
-When you agent is invoked, it will process the data and send the output to the output destination.
+When your agent is invoked, it will process the data and send the output to the output destination.📝 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.
| <ThemeImage baseName="agent-io-new" alt="Agent New IO" /> | |
| When you agent is invoked, it will process the data and send the output to the output destination. | |
| <ThemeImage baseName="agent-io-new" alt="Agent New IO" /> | |
| When your agent is invoked, it will process the data and send the output to the output destination. |
🧰 Tools
🪛 LanguageTool
[grammar] ~63-~63: Check that the noun ‘agent’ after the pronoun ‘you’ is correct. It’s possible that you may need to switch to a possessive pronoun, or use another part of speech.
Context: ...nt-io-new" alt="Agent New IO" /> When you agent is invoked, it will process the data an...
(PRP_VB)
🤖 Prompt for AI Agents
In content/Cloud/agents.mdx around lines 61 to 64, fix the typo in the sentence
by changing "When you agent is invoked" to "When your agent is invoked" to use
the correct possessive pronoun.
| --- | ||
| title: Agent Dashboard | ||
| description: Overview of the agent dashboard in Agentuity Cloud | ||
| title: Agents | ||
| description: The agents page is for managing your agents | ||
| --- | ||
|
|
||
| ## Agent Dashboard Overview |
There was a problem hiding this comment.
Imports missing for MDX UI components. This file uses <ThemeImage>, <Mermaid>, <CodeExample>, <CLICommand>, <Callout>, and <Sparkle> components without importing them. Add the necessary imports at the top to ensure proper rendering.
Example diff:
---
title: Agents
description: The agents page is for managing your agents
---
+import { Callout } from 'fumadocs-ui/components/callout';
+import { ThemeImage } from 'fumadocs-ui/components/theme-image';
+import Mermaid from 'components/Mermaid';
+import CodeExample from 'components/CodeExample';
+import { CLICommand } from 'components/CLICommand';
+import Sparkle from 'components/Sparkle';📝 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.
| --- | |
| title: Agent Dashboard | |
| description: Overview of the agent dashboard in Agentuity Cloud | |
| title: Agents | |
| description: The agents page is for managing your agents | |
| --- | |
| ## Agent Dashboard Overview | |
| --- | |
| title: Agents | |
| description: The agents page is for managing your agents | |
| --- | |
| import { Callout } from 'fumadocs-ui/components/callout'; | |
| import { ThemeImage } from 'fumadocs-ui/components/theme-image'; | |
| import Mermaid from 'components/Mermaid'; | |
| import CodeExample from 'components/CodeExample'; | |
| import { CLICommand } from 'components/CLICommand'; | |
| import Sparkle from 'components/Sparkle'; | |
| ## Agent Dashboard Overview |
🤖 Prompt for AI Agents
In content/Cloud/agents.mdx at the top of the file (lines 1 to 6), imports for
the MDX UI components such as ThemeImage, Mermaid, CodeExample, CLICommand,
Callout, and Sparkle are missing. Add import statements for each of these
components at the beginning of the file to ensure they render correctly in the
MDX content.
Summary by CodeRabbit
New Features
Improvements
Bug Fixes / Chores
Removals