docs: major documentation overhaul (new guides, REST refs, fixes, navigation)

[standujar]

Summary

Complete documentation bringing coverage from ~60% to ~95%, adding missing content, fixing bugs, and making docs more engaging.

---

New Content Created

Guides

• guides/streaming-responses.mdx - SSE/WebSocket streaming modes
• guides/action-planning.mdx - Multi-step action workflows
• guides/background-tasks.mdx - Task workers & recurring jobs
• guides/deploy-to-cloud.mdx - Eliza Cloud deployment guide

REST API Docs

• rest-reference/jobs/create-job.mdx
• rest-reference/jobs/get-job.mdx
• rest-reference/jobs/jobs-health.mdx
• rest-reference/runs/list-agent-runs.mdx
• rest-reference/runs/get-agent-run.mdx

Reference

• runtime/types-reference.mdx - 50+ missing types documented

---

Content Improvements

Vivified Pages (engaging tone, problem-first approach)

• index.mdx - Token card + "3 commands" hook
• quickstart.mdx - Added "Next Steps" section
• runtime/core.mdx - "The Problem" intro + quick start
• plugins/components.mdx - Use-case driven structure
• agents/character-interface.mdx - "2 minutes" quick win

Bug Fixes (P0/P1)

• Fixed State interface (completely wrong)
• Fixed createMemory() signature (missing tableName)
• Fixed searchMemories method name
• Fixed composeState method name
• Added missing Memory properties (agentId, unique, similarity)
• Added PATCH to Route types (4 files)
• Documented HandlerOptions interface
• Fixed voice IDs in test examples
• Removed deprecated CLI commands (plugins upgrade/generate)

Deleted (non-existent endpoints)

• mark-message-processing-as-complete.mdx
• create-group-channel.mdx

---

Navigation Improvements

Submenus Added (docs.json)

GUIDES (12 pages → 3 groups):

• Agent Configuration (customize, multiple agents, streaming)
• Development (action-planning, background-tasks, testing, plugins)
• Deployment (deploy, cloud, TEE, contribute)

RUNTIME (9 pages → 2 groups):

• Core Concepts (core, memory, events, providers)
• Communication (models, services, messaging, sessions-api)

Cross-links Added

• runtime/core.mdx → streaming, action-planning, background-tasks, deploy-to-cloud
• plugins/development.mdx → publish-a-plugin, deploy-to-cloud
• plugins/components.mdx → action-planning, streaming, background-tasks, core
• agents/character-interface.mdx → core runtime, deploy-to-cloud
• quickstart.mdx → customize, create-plugin, deploy-to-cloud, plugin-registry

Deprecated Routes

• Added <Warning> notices to /central-* endpoints (3 files)

---

CLI Documentation

Global Flags Added (cli-reference/overview.mdx)

• --no-emoji
• --no-auto-install
• -d, --debug
• --verbose
• -q, --quiet
• --log-json

---

Eliza Cloud

Featured prominently as primary deployment option:

• New comprehensive guide (deploy-to-cloud.mdx)
• Updated deploy-a-project.mdx with comparison table
• Highlighted ERC-8004, X402, marketplace features

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

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.

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/updates

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[claude]

Claude encountered an error —— View job

---

I'll analyze this and get back to you.

[claude]

Claude encountered an error —— View job

---

I'll analyze this and get back to you.

[claude]

Claude encountered an error —— View job

---

I'll analyze this and get back to you.