Skip to content

Conversation

@mcongrove
Copy link
Member

@mcongrove mcongrove commented Jan 8, 2026

Summary by CodeRabbit

Release Notes

  • New Features

    • Comprehensive new documentation suite covering agents, APIs, frontend integration, CLI reference, and learning tutorials
    • Added authentication guide and deployment scenario documentation
    • New sidebar footer linking to legacy documentation
    • Expanded Frontend section with React hooks, RPC client, and provider setup guides
  • Documentation

    • Restructured documentation with new "Get Started" and "Learn" sections
    • Added cookbook with patterns and tutorials for common workflows
    • Added CLI reference guide with deployment, development, and debugging documentation
  • Refactor

    • Updated navigation references from "Console" to "App"

✏️ Tip: You can customize this high-level summary in your review settings.

parteeksingh24 and others added 30 commits November 18, 2025 09:20
- Flip version picker: v0 is "Current", v1 is "Preview"
- Replace deprecation banner with preview banner
- Update install/quickstart to use agentuity CLI
- Remove TODOs and archived content
- Add Cookbook section with tutorials and patterns
- Update message in preview banner
- Align logo on sidebar
- Update naming to Routes/ with expanded content
- Add more accurate callouts to route pages
- Add middleware sections to email, SSE, WebSocket docs
- Consolidate API pages (content moved to Routes)
- Fix cross-referenced links throughout
Signed-off-by: Matthew Congrove <mcongrove@agentuity.com>
@cloudflare-workers-and-pages
Copy link

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
🚫 Deployment cancelled
View logs
docs-preview 8a1a81d Jan 08 2026, 09:06 PM

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 8, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This PR performs a comprehensive restructuring of documentation from an older architecture (Introduction, CLI, Changelog, Cloud, Guides, Examples sections) to a new information model (Get-Started, Frontend, Agents, APIs, Learn/Cookbook). It systematically converts type imports throughout the codebase to type-only imports, adds new UI components for documentation layout, and makes minor code adjustments in agent processing logic.

Changes

Cohort / File(s) Summary
Configuration & Environment
.env.example, .gitignore
Added AGENT_BEARER_TOKEN environment variable; added .gitignore patterns for public markdown, Claude Code, and Agentuity App files.
Type-Only Import Refactoring
app/api/sessions/*/route.ts, app/api/tutorials/*/route.ts, app/api/users/tutorial-state/route.ts, app/chat/SessionContext.tsx, app/chat/[sessionId]/page.tsx, app/chat/components/ChatInput.tsx, app/chat/components/ChatMessage.tsx, app/chat/components/ChatMessagesArea.tsx, app/chat/components/CodeEditor.tsx, app/chat/components/SessionSidebar.tsx, app/chat/components/TutorialFileChip.tsx, app/chat/layout.tsx, app/chat/services/sessionService.ts, app/chat/utils/useStreaming.ts, components/ui/skeleton.tsx, components/TutorialStep.tsx
Converted imports of TypeScript types (NextRequest, Session, Message, TutorialData, etc.) from value imports to type-only imports across API routes and React components. No runtime behavior impact.
Agent Processing Logic Adjustments
agent-docs/src/agents/agent-pulse/index.ts, agent-docs/src/agents/agent-pulse/request/parser.ts, agent-docs/src/agents/agent-pulse/state/manager.ts, agent-docs/src/agents/agent-pulse/streaming/processor.ts, agent-docs/src/agents/agent-pulse/tools.ts
Minor type/initialization changes: removed explicit type annotation on systemPrompt, removed variable initialization for message and tutorialData, removed else block in error handling, changed mutable string accumulator to const (potential issue), normalized string formatting. ⚠️ Review note: const on accumulatedContent conflicts with later mutation.
Documentation UI & Layout
app/(docs)/[[...slug]]/page.tsx, app/(docs)/layout.tsx, app/global.css, app/layout.config.tsx, components/SidebarBanner.tsx, components/SidebarFooter.tsx, components/Tag.tsx
Added Tag component and SidebarFooter to MDX mappings; configured sidebar in DocsLayout; added CSS styling for prose link colors; updated navigation URLs and labels from "Console" to "App"; removed mb-4 from header.
Code Component Updates
components/CodeFromFiles.tsx, components/CopyPageDropdown.tsx
Replaced local CodeBlock with DynamicCodeBlock; simplified markdown file handling to direct URL opening instead of fetch-based workflow.
LLM/Documentation Routes
app/llms.txt/route.ts, app/llms-full.txt/route.ts
Simplified About/Capabilities sections; changed document rendering from explicit file/meta/content blocks to markdown links; added error handling with 500 response; adjusted preamble formatting.
Documentation Structure Migration
Removed: content/Introduction/*, content/CLI/*, content/Changelog/*, content/Cloud/*, content/Examples/index.mdx, content/Guides/* (all guide files and meta.json)
Deleted entire old documentation sections: Introduction (5 files), CLI (10 files), Changelog (4 files), Cloud (9 files), Examples index, and Guides (13 files + meta.json). These totals ~1,800+ lines of deletion.
Documentation Structure Addition
Added: content/Get-Started/*, content/Frontend/*, content/Agents/*, content/APIs/*, content/Learn/Cookbook/*, content/Reference/CLI/*, content/Build/meta.json
Added new documentation architecture with comprehensive guides: Get-Started (5 pages ~450 lines), Frontend (7 pages ~1,100 lines), Agents (11 pages ~3,100 lines), APIs (2 pages ~380 lines), Learn/Cookbook (overview + 7 tutorials/patterns ~2,400 lines), Reference/CLI (10 pages ~2,500 lines), Build meta. Total ~9,500+ lines added.
Agent Documentation Updates
agent-docs/README.md
Updated terminology from "Agentuity Console" to "Agentuity App" in DevMode reference.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Rationale: Type-only import changes are systematic and repetitive across ~25 files (straightforward pattern verification). Documentation migration is extensive (~12,000+ lines shifted) but mostly content-based with limited risk. However, requires careful scrutiny of: (1) const/let change in streaming processor that conflicts with later mutation, (2) else-block removal in state manager, (3) initialization pattern removals, and (4) verification that all documentation content migrated correctly to new structure.

Possibly related PRs

  • V2 documentation #171: Modifies overlapping documentation UI files (app/(docs)/ layout and components, global styles) with related doc-component and sidebar configuration updates.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch v1-docs

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f52845 and 8a1a81d.

📒 Files selected for processing (274)
  • .env.example
  • .gitignore
  • agent-docs/README.md
  • agent-docs/src/agents/agent-pulse/index.ts
  • agent-docs/src/agents/agent-pulse/request/parser.ts
  • agent-docs/src/agents/agent-pulse/state/manager.ts
  • agent-docs/src/agents/agent-pulse/streaming/processor.ts
  • agent-docs/src/agents/agent-pulse/tools.ts
  • app/(docs)/[[...slug]]/page.tsx
  • app/(docs)/layout.tsx
  • app/api/sessions/[sessionId]/messages/route.ts
  • app/api/sessions/[sessionId]/route.ts
  • app/api/sessions/route.ts
  • app/api/tutorials/[id]/route.ts
  • app/api/tutorials/[id]/steps/[stepNumber]/route.ts
  • app/api/users/tutorial-state/route.ts
  • app/chat/SessionContext.tsx
  • app/chat/[sessionId]/page.tsx
  • app/chat/components/ChatInput.tsx
  • app/chat/components/ChatMessage.tsx
  • app/chat/components/ChatMessagesArea.tsx
  • app/chat/components/CodeEditor.tsx
  • app/chat/components/SessionSidebar.tsx
  • app/chat/components/TutorialFileChip.tsx
  • app/chat/layout.tsx
  • app/chat/services/sessionService.ts
  • app/chat/utils/useStreaming.ts
  • app/global.css
  • app/layout.config.tsx
  • app/llms-full.txt/route.ts
  • app/llms.txt/route.ts
  • components/CodeFromFiles.tsx
  • components/CopyPageDropdown.tsx
  • components/SidebarBanner.tsx
  • components/SidebarFooter.tsx
  • components/Tag.tsx
  • components/TutorialStep.tsx
  • components/ui/skeleton.tsx
  • content/APIs/calling-agents.mdx
  • content/APIs/meta.json
  • content/APIs/when-to-use.mdx
  • content/Agents/ai-gateway.mdx
  • content/Agents/ai-sdk-integration.mdx
  • content/Agents/calling-other-agents.mdx
  • content/Agents/creating-agents.mdx
  • content/Agents/evaluations.mdx
  • content/Agents/events-lifecycle.mdx
  • content/Agents/meta.json
  • content/Agents/schema-libraries.mdx
  • content/Agents/standalone-execution.mdx
  • content/Agents/state-management.mdx
  • content/Agents/streaming-responses.mdx
  • content/Agents/workbench.mdx
  • content/Build/meta.json
  • content/CLI/agent.mdx
  • content/CLI/apikey.mdx
  • content/CLI/auth.mdx
  • content/CLI/bundle.mdx
  • content/CLI/cloud.mdx
  • content/CLI/dev.mdx
  • content/CLI/env.mdx
  • content/CLI/installation.mdx
  • content/CLI/mcp.mdx
  • content/CLI/meta.json
  • content/CLI/project.mdx
  • content/CLI/version.mdx
  • content/Changelog/cli.mdx
  • content/Changelog/index.mdx
  • content/Changelog/meta.json
  • content/Changelog/sdk-js.mdx
  • content/Changelog/sdk-py.mdx
  • content/Cloud/agents.mdx
  • content/Cloud/aigateway.mdx
  • content/Cloud/api-keys.mdx
  • content/Cloud/index.mdx
  • content/Cloud/key-value-memory.mdx
  • content/Cloud/meta.json
  • content/Cloud/object-storage.mdx
  • content/Cloud/organization.mdx
  • content/Cloud/project.mdx
  • content/Cloud/settings.mdx
  • content/Cloud/vector-memory.mdx
  • content/Examples/index.mdx
  • content/Frontend/advanced-hooks.mdx
  • content/Frontend/authentication.mdx
  • content/Frontend/deployment-scenarios.mdx
  • content/Frontend/meta.json
  • content/Frontend/provider-setup.mdx
  • content/Frontend/react-hooks.mdx
  • content/Frontend/rpc-client.mdx
  • content/Frontend/workbench.mdx
  • content/Get-Started/app-configuration.mdx
  • content/Get-Started/installation.mdx
  • content/Get-Started/meta.json
  • content/Get-Started/project-structure.mdx
  • content/Get-Started/quickstart.mdx
  • content/Get-Started/what-is-agentuity.mdx
  • content/Guides/.agent-patterns.mdx
  • content/Guides/.security.mdx
  • content/Guides/agent-communication.mdx
  • content/Guides/agent-data-handling.mdx
  • content/Guides/agent-engineering.mdx
  • content/Guides/agent-io.mdx
  • content/Guides/agent-logging.mdx
  • content/Guides/agent-native-cloud.mdx
  • content/Guides/agent-streaming.mdx
  • content/Guides/agent-telemetry.mdx
  • content/Guides/agent-tracing.mdx
  • content/Guides/ai-gateway.mdx
  • content/Guides/devmode.mdx
  • content/Guides/key-value.mdx
  • content/Guides/meta.json
  • content/Guides/object-storage.mdx
  • content/Guides/vector-db.mdx
  • content/Guides/what-is-an-agent.mdx
  • content/Introduction/architecture.mdx
  • content/Introduction/getting-started.mdx
  • content/Introduction/index.mdx
  • content/Introduction/kitchen-sink.mdx
  • content/Introduction/meta.json
  • content/Introduction/templates.mdx
  • content/Learn/Cookbook/Patterns/background-tasks.mdx
  • content/Learn/Cookbook/Patterns/chat-with-history.mdx
  • content/Learn/Cookbook/Patterns/cron-with-storage.mdx
  • content/Learn/Cookbook/Patterns/meta.json
  • content/Learn/Cookbook/Patterns/product-search.mdx
  • content/Learn/Cookbook/Patterns/server-utilities.mdx
  • content/Learn/Cookbook/Patterns/tailwind-setup.mdx
  • content/Learn/Cookbook/Patterns/webhook-handler.mdx
  • content/Learn/Cookbook/Tutorials/meta.json
  • content/Learn/Cookbook/Tutorials/rag-agent.mdx
  • content/Learn/Cookbook/Tutorials/understanding-agents.mdx
  • content/Learn/Cookbook/meta.json
  • content/Learn/Cookbook/overview.mdx
  • content/Learn/meta.json
  • content/Reference/CLI/ai-commands.mdx
  • content/Reference/CLI/build-configuration.mdx
  • content/Reference/CLI/configuration.mdx
  • content/Reference/CLI/debugging.mdx
  • content/Reference/CLI/deployment.mdx
  • content/Reference/CLI/development.mdx
  • content/Reference/CLI/getting-started.mdx
  • content/Reference/CLI/index.mdx
  • content/Reference/CLI/meta.json
  • content/Reference/CLI/sandbox.mdx
  • content/Reference/CLI/storage.mdx
  • content/Reference/meta.json
  • content/Reference/migration-guide.mdx
  • content/Reference/sdk-reference.mdx
  • content/Routes/cron.mdx
  • content/Routes/http.mdx
  • content/Routes/index.mdx
  • content/Routes/meta.json
  • content/Routes/middleware.mdx
  • content/Routes/sse.mdx
  • content/Routes/websockets.mdx
  • content/SDKs/index.mdx
  • content/SDKs/javascript/api-reference.mdx
  • content/SDKs/javascript/core-concepts.mdx
  • content/SDKs/javascript/error-handling.mdx
  • content/SDKs/javascript/examples/index.mdx
  • content/SDKs/javascript/examples/langchain.mdx
  • content/SDKs/javascript/frameworks.mdx
  • content/SDKs/javascript/index.mdx
  • content/SDKs/javascript/llm.mdx
  • content/SDKs/javascript/meta.json
  • content/SDKs/javascript/troubleshooting.mdx
  • content/SDKs/meta.json
  • content/SDKs/python/api-reference.mdx
  • content/SDKs/python/async-api.mdx
  • content/SDKs/python/core-concepts.mdx
  • content/SDKs/python/data-handling.mdx
  • content/SDKs/python/examples/index.mdx
  • content/SDKs/python/examples/pydantic.mdx
  • content/SDKs/python/frameworks.mdx
  • content/SDKs/python/index.mdx
  • content/SDKs/python/llm.mdx
  • content/SDKs/python/meta.json
  • content/Services/Observability/logging.mdx
  • content/Services/Observability/meta.json
  • content/Services/Observability/sessions-debugging.mdx
  • content/Services/Observability/tracing.mdx
  • content/Services/Sandbox/index.mdx
  • content/Services/Sandbox/meta.json
  • content/Services/Sandbox/sdk-usage.mdx
  • content/Services/Sandbox/snapshots.mdx
  • content/Services/Storage/custom.mdx
  • content/Services/Storage/database.mdx
  • content/Services/Storage/durable-streams.mdx
  • content/Services/Storage/key-value.mdx
  • content/Services/Storage/meta.json
  • content/Services/Storage/object.mdx
  • content/Services/Storage/vector.mdx
  • content/Troubleshooting/error-codes/authentication.mdx
  • content/Troubleshooting/error-codes/cli.mdx
  • content/Troubleshooting/error-codes/datastores.mdx
  • content/Troubleshooting/error-codes/index.mdx
  • content/Troubleshooting/error-codes/integration.mdx
  • content/Troubleshooting/error-codes/projects.mdx
  • content/Troubleshooting/error-codes/system.mdx
  • content/meta.json
  • examples/training/01-intro/step1-basic-agent/agent.ts
  • examples/training/01-intro/step1-basic-agent/route.ts
  • examples/training/01-intro/step2-with-logging/agent.ts
  • examples/training/01-intro/step2-with-logging/route.ts
  • examples/training/01-intro/step3-with-storage/agent.ts
  • examples/training/01-intro/step3-with-storage/route.ts
  • examples/training/01-intro/step4-schema-validation/agent.ts
  • examples/training/01-intro/step4-schema-validation/route.ts
  • examples/training/02-anatomy/step1-two-file-pattern/agent.ts
  • examples/training/02-anatomy/step1-two-file-pattern/route.ts
  • examples/training/02-anatomy/step2-http-routing/agent.ts
  • examples/training/02-anatomy/step2-http-routing/route.ts
  • examples/training/02-anatomy/step3-context-object/agent.ts
  • examples/training/02-anatomy/step3-context-object/route.ts
  • examples/training/02-anatomy/step4-request-response/agent.ts
  • examples/training/02-anatomy/step4-request-response/route.ts
  • examples/training/03-specialized-routes/step1-status-checker/agent.ts
  • examples/training/03-specialized-routes/step1-status-checker/route.ts
  • examples/training/03-specialized-routes/step2-email-responder/agent.ts
  • examples/training/03-specialized-routes/step2-email-responder/route.ts
  • examples/training/03-specialized-routes/step3-realtime-echo/agent.ts
  • examples/training/03-specialized-routes/step3-realtime-echo/route.ts
  • examples/training/03-specialized-routes/step4-multi-trigger-notifications/agent.ts
  • examples/training/03-specialized-routes/step4-multi-trigger-notifications/route.ts
  • examples/training/04-state-management/step1-request-state/agent.ts
  • examples/training/04-state-management/step1-request-state/route.ts
  • examples/training/04-state-management/step2-thread-state/agent.ts
  • examples/training/04-state-management/step2-thread-state/route.ts
  • examples/training/04-state-management/step3-session-state/agent.ts
  • examples/training/04-state-management/step3-session-state/route.ts
  • examples/training/04-state-management/step4-state-lifecycle/agent.ts
  • examples/training/04-state-management/step4-state-lifecycle/route.ts
  • examples/training/05-storage-apis/step1-kv-basics/agent.ts
  • examples/training/05-storage-apis/step1-kv-basics/route.ts
  • examples/training/05-storage-apis/step2-kv-persistent/agent.ts
  • examples/training/05-storage-apis/step2-kv-persistent/route.ts
  • examples/training/05-storage-apis/step3-vector-basics/agent.ts
  • examples/training/05-storage-apis/step3-vector-basics/route.ts
  • examples/training/05-storage-apis/step4-vector-filtering/agent.ts
  • examples/training/05-storage-apis/step4-vector-filtering/route.ts
  • examples/training/05-storage-apis/step5-object-storage/agent.ts
  • examples/training/05-storage-apis/step5-object-storage/route.ts
  • examples/training/06-agent-communication/step1-basic-agent-calls/coordinator/agent.ts
  • examples/training/06-agent-communication/step1-basic-agent-calls/coordinator/route.ts
  • examples/training/06-agent-communication/step1-basic-agent-calls/enricher/agent.ts
  • examples/training/06-agent-communication/step1-basic-agent-calls/enricher/route.ts
  • examples/training/06-agent-communication/step2-sequential-workflows/coordinator/agent.ts
  • examples/training/06-agent-communication/step2-sequential-workflows/coordinator/route.ts
  • examples/training/06-agent-communication/step3-parallel-execution/aggregator/agent.ts
  • examples/training/06-agent-communication/step3-parallel-execution/aggregator/route.ts
  • examples/training/06-agent-communication/step4-smart-routing/router/agent.ts
  • examples/training/06-agent-communication/step4-smart-routing/router/route.ts
  • examples/training/06-agent-communication/step4-smart-routing/support-agent/agent.ts
  • examples/training/06-agent-communication/step4-smart-routing/support-agent/route.ts
  • examples/training/07-observability-evals-validation/step1-basic-evaluations/agent.ts
  • examples/training/07-observability-evals-validation/step1-basic-evaluations/route.ts
  • examples/training/07-observability-evals-validation/step2-advanced-evals/agent.ts
  • examples/training/07-observability-evals-validation/step2-advanced-evals/route.ts
  • examples/training/07-observability-evals-validation/step3-event-system/agent.ts
  • examples/training/07-observability-evals-validation/step3-event-system/route.ts
  • examples/training/07-observability-evals-validation/step4-structured-logging/agent.ts
  • examples/training/07-observability-evals-validation/step4-structured-logging/route.ts
  • examples/training/07-observability-evals-validation/step5-advanced-validation/agent.ts
  • examples/training/07-observability-evals-validation/step5-advanced-validation/route.ts
  • examples/training/07-observability-evals-validation/step6-custom-spans/agent.ts
  • examples/training/07-observability-evals-validation/step6-custom-spans/route.ts
  • lib/tutorial/mdx-parser.ts
  • lib/tutorial/state-manager.ts
  • lib/validation/middleware.ts
  • next.config.mjs
  • package.json
  • scripts/generate-markdown-files.js
  • wrangler.jsonc

Comment @coderabbitai help to get the list of available commands and usage tips.

@mcongrove mcongrove merged commit bba4c12 into main Jan 8, 2026
0 of 2 checks passed
@mcongrove mcongrove deleted the v1-docs branch January 8, 2026 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants