Skip to content

Add framework-first v3 docs#1462

Draft
parteeksingh24 wants to merge 7 commits into
mainfrom
docs/v3-docs
Draft

Add framework-first v3 docs#1462
parteeksingh24 wants to merge 7 commits into
mainfrom
docs/v3-docs

Conversation

@parteeksingh24
Copy link
Copy Markdown
Contributor

@parteeksingh24 parteeksingh24 commented May 11, 2026

Reworks the v3 docs into a framework-first documentation set with updated IA, service guidance, migration coverage, generated docs artifacts, and a TanStack Start docs runtime that still deploys through Agentuity.

Note: this branch was rebuilt on top of main after an unintended sync with origin/v3 pulled beta-line changes into the PR history.

Summary

  • Reshape the v3 docs IA around Get Started, Frameworks, Build, Services, Deploy and Operate, Cookbook, Reference, and Migration
  • Add framework-first guides for Next.js, Nuxt, React Router, SvelteKit, Astro, Hono, Vite React, and TanStack Start
  • Move older agent, route, and frontend material into Build, Frameworks, and Services pages that match the current v3 app model
  • Refresh core service docs for AI Gateway, Sandbox, Coder, Database, Observability, Storage, Queues, Tasks, Schedules, Webhooks, Authentication, and OIDC
  • Update cookbook pages toward problem, complete solution, and variation structure, with code appearing earlier
  • Add migration coverage for v2 docs concepts and runtime-style apps moving toward framework apps
  • Regenerate docs artifacts for nav data, route files, route tree, schema output, markdown export, sitemap, Pagefind, and redirects
  • Update docs authoring guidance for current framework verification, generated reference docs, sidebar labels, and service-client examples

Approach Notes

This PR keeps the docs deployed through Agentuity, but changes the docs app build and runtime path to TanStack Start:

  • bun run build runs the TanStack Start Vite build
  • bun run start serves dist/server.js
  • agentuity deploy --dir . remains the deployment entry point
  • legacy docs redirects now run through a Start-native server entry before falling through to the Start handler

The old runtime/Hono redirect layer still exists for Agentuity app wiring, but the built docs server now owns the redirect behavior used by local and packaged Start output.

Verification

  • bun run typecheck
  • bun run build
  • local browser smoke at http://localhost:3000
  • route smoke:
    • /frameworks/nextjs -> 200
    • /build/agents -> 200
    • /services/ai-gateway -> 200
  • legacy redirect smoke:
    • /agents/ai-gateway -> 301 /services/ai-gateway
    • /demo/ai-gateway -> 301 /explorer/ai-gateway
    • /frontend/rpc-client -> 301 /cookbook/patterns/hono-rpc-tanstack-query
    • /reference/sdk-reference/storage -> 301 /services/storage

References

@agentuity-agent
Copy link
Copy Markdown

agentuity-agent Bot commented May 11, 2026

The latest Agentuity deployment details.

Project Deployment Preview Updated (UTC)
docs 🔴 Failed (deploy_ebbe11d9aa5cba0931c4eb2d4981fcbd) - 2026-05-29T15:06:49Z

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 878b28c7-c959-46be-9d17-154df81fd374

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@parteeksingh24 parteeksingh24 mentioned this pull request May 11, 2026
@parteeksingh24 parteeksingh24 changed the title Align v3 docs around framework apps Add v3 docs May 11, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

📦 Canary Packages Published

version: 3.0.1-27d2b25

Packages
Package Version URL
@agentuity/stream 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-stream-3.0.1-27d2b25.tgz
@agentuity/opencode 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-opencode-3.0.1-27d2b25.tgz
@agentuity/claude-code 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-claude-code-3.0.1-27d2b25.tgz
@agentuity/schedule 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-schedule-3.0.1-27d2b25.tgz
create-agentuity 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/create-agentuity-3.0.1-27d2b25.tgz
@agentuity/postgres 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-postgres-3.0.1-27d2b25.tgz
@agentuity/schema 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-schema-3.0.1-27d2b25.tgz
@agentuity/hono 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-hono-3.0.1-27d2b25.tgz
@agentuity/drizzle 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-drizzle-3.0.1-27d2b25.tgz
@agentuity/db 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-db-3.0.1-27d2b25.tgz
@agentuity/aigateway 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-aigateway-3.0.1-27d2b25.tgz
@agentuity/webhook 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-webhook-3.0.1-27d2b25.tgz
@agentuity/coder 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-coder-3.0.1-27d2b25.tgz
@agentuity/core 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-core-3.0.1-27d2b25.tgz
@agentuity/coder-tui 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-coder-tui-3.0.1-27d2b25.tgz
@agentuity/vector 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-vector-3.0.1-27d2b25.tgz
@agentuity/cli 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-cli-3.0.1-27d2b25.tgz
@agentuity/server 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-server-3.0.1-27d2b25.tgz
@agentuity/storage 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-storage-3.0.1-27d2b25.tgz
@agentuity/runtime 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-runtime-3.0.1-27d2b25.tgz
@agentuity/pi 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-pi-3.0.1-27d2b25.tgz
@agentuity/migrate 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-migrate-3.0.1-27d2b25.tgz
@agentuity/telemetry 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-telemetry-3.0.1-27d2b25.tgz
@agentuity/adapter 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-adapter-3.0.1-27d2b25.tgz
@agentuity/queue 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-queue-3.0.1-27d2b25.tgz
@agentuity/local 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-local-3.0.1-27d2b25.tgz
@agentuity/vite 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-vite-3.0.1-27d2b25.tgz
@agentuity/analytics 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-analytics-3.0.1-27d2b25.tgz
@agentuity/keyvalue 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-keyvalue-3.0.1-27d2b25.tgz
@agentuity/task 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-task-3.0.1-27d2b25.tgz
@agentuity/email 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-email-3.0.1-27d2b25.tgz
@agentuity/sandbox 3.0.1-27d2b25 https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-sandbox-3.0.1-27d2b25.tgz
Install

Add to your package.json:

{
  "dependencies": {
    "@agentuity/stream": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-stream-3.0.1-27d2b25.tgz",
    "@agentuity/opencode": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-opencode-3.0.1-27d2b25.tgz",
    "@agentuity/claude-code": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-claude-code-3.0.1-27d2b25.tgz",
    "@agentuity/schedule": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-schedule-3.0.1-27d2b25.tgz",
    "create-agentuity": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/create-agentuity-3.0.1-27d2b25.tgz",
    "@agentuity/postgres": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-postgres-3.0.1-27d2b25.tgz",
    "@agentuity/schema": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-schema-3.0.1-27d2b25.tgz",
    "@agentuity/hono": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-hono-3.0.1-27d2b25.tgz",
    "@agentuity/drizzle": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-drizzle-3.0.1-27d2b25.tgz",
    "@agentuity/db": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-db-3.0.1-27d2b25.tgz",
    "@agentuity/aigateway": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-aigateway-3.0.1-27d2b25.tgz",
    "@agentuity/webhook": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-webhook-3.0.1-27d2b25.tgz",
    "@agentuity/coder": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-coder-3.0.1-27d2b25.tgz",
    "@agentuity/core": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-core-3.0.1-27d2b25.tgz",
    "@agentuity/coder-tui": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-coder-tui-3.0.1-27d2b25.tgz",
    "@agentuity/vector": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-vector-3.0.1-27d2b25.tgz",
    "@agentuity/cli": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-cli-3.0.1-27d2b25.tgz",
    "@agentuity/server": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-server-3.0.1-27d2b25.tgz",
    "@agentuity/storage": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-storage-3.0.1-27d2b25.tgz",
    "@agentuity/runtime": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-runtime-3.0.1-27d2b25.tgz",
    "@agentuity/pi": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-pi-3.0.1-27d2b25.tgz",
    "@agentuity/migrate": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-migrate-3.0.1-27d2b25.tgz",
    "@agentuity/telemetry": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-telemetry-3.0.1-27d2b25.tgz",
    "@agentuity/adapter": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-adapter-3.0.1-27d2b25.tgz",
    "@agentuity/queue": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-queue-3.0.1-27d2b25.tgz",
    "@agentuity/local": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-local-3.0.1-27d2b25.tgz",
    "@agentuity/vite": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-vite-3.0.1-27d2b25.tgz",
    "@agentuity/analytics": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-analytics-3.0.1-27d2b25.tgz",
    "@agentuity/keyvalue": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-keyvalue-3.0.1-27d2b25.tgz",
    "@agentuity/task": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-task-3.0.1-27d2b25.tgz",
    "@agentuity/email": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-email-3.0.1-27d2b25.tgz",
    "@agentuity/sandbox": "https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-sandbox-3.0.1-27d2b25.tgz"
  }
}

Or install directly:

bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-stream-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-opencode-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-claude-code-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-schedule-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/create-agentuity-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-postgres-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-schema-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-hono-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-drizzle-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-db-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-aigateway-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-webhook-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-coder-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-core-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-coder-tui-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-vector-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-cli-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-server-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-storage-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-runtime-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-pi-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-migrate-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-telemetry-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-adapter-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-queue-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-local-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-vite-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-analytics-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-keyvalue-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-task-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-email-3.0.1-27d2b25.tgz
bun add https://agentuity-sdk-objects.t3.storageapi.dev/npm/3.0.1-27d2b25/agentuity-sandbox-3.0.1-27d2b25.tgz

@blacksmith-sh

This comment has been minimized.

Base automatically changed from v3 to main May 22, 2026 19:22
- Reorganize docs around frameworks, build, and services
- Add migration, deploy, and getting-started guidance
- Align setup and storage docs with the current v3 CLI
- Regenerate routes, nav data, schemas, and API references
@parteeksingh24 parteeksingh24 marked this pull request as draft May 26, 2026 17:11
@parteeksingh24 parteeksingh24 changed the title Add v3 docs Add framework-first v3 docs May 26, 2026
@blacksmith-sh

This comment has been minimized.

- refresh v3 docs from the section-by-section audit
- replace stale beta install and create examples with next
- reframe chat and handler demos around conversation and Hono routes
- update migration, deploy, and service guidance to match current SDK
- Drop `Community` from nav and docs home
- Delete the `/community` page and orphaned assets
- Leave cross-version fallback redirects for later
- split Build into Apps and APIs plus Agents
- move agent docs under `/build/agents`
- add Apps and APIs starter pages
- refresh Home for the v3 docs IA
- retune Explorer names, groups, and explanations
- make Explorer sandbox output marker-based
- pass org context into standalone service clients
- add redirects for moved Build pages
- type `@agentuity/hono` middleware for Hono apps
- Add cookbook patterns for evals, logs, and traces
- Cover `OpenAI Evals` and `Braintrust` examples
- Add `Pino`, `LogTape`, `OpenTelemetry`, and `Langfuse` guides
- Clarify framework import flows for existing apps
- Document local `@agentuity/cli` install and undo paths
- Tighten framework build and deploy checks
- Refresh get-started, service, reference, and migration docs
- Regenerate docs nav, routes, and cookbook listings
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.

1 participant