Design documentation#

Find designs and implementation boundaries by subsystem. Start with the entries below, then expand the matching sidebar category for detailed designs, comparisons and related notes.

The sidebar starts with seven areas. Expand an area, choose a module, then open a page. Navigation expands the complete current path; filtering matches both page and category names.

Reading order#

1. Understand the system: framework overview → repository structure.
2. Trace an execution: call flow → execution control → session storage.
3. Change a subsystem: choose a topic below, read its design and implementation-status appendix, then verify source ownership and acceptance requirements.

Architecture#

Understand the whole system, source ownership and implementation boundaries.

Framework overview · Repository structure · Implementation navigation

Agents and workflows#

Follow execution, session persistence, branching and recovery in that order.

Execution control · Session storage · Session DAG · Goals and restart recovery · Agent configuration

Understand function calls, workflow composition and application execution before the report examples.

Function calling · Program model · Application runtime · Report workflows

Read the event contract before policies, proactive actions and scheduling.

Event layer · Rule execution · Scheduling and memory

Context and memory#

Separate per-request context assembly from persistent memory and attribution.

Context overview · Context composition · Compaction · Memory overview · Entity memory

Interfaces#

Start with state and interaction rules; then choose chat, browser, workspace, settings or terminal.

UI overview · State layer · Chat and composer · Built-in browser · Project workspace · CLI and TUI

Models and connections#

Keep request construction, model options, account resolution and failure handling distinct.

Model catalog · Request building · Account management · Retry behavior · Usage metering

Find harness, MCP, skills, plugin and channel contracts.

Harness standard · MCP integration · MCP server · Extension gating · Channels

Security and engineering#

Read execution authority separately from installation, updates and platform support.

Authority and sandbox · System access · Dependency security · Installation and packaging · Automatic updates

Find shared verification rules, error handling and documentation maintenance.

Test system · Error handling · Documentation structure and rendering · Site discoverability

Supporting material#

• Prototypes: layout and interaction experiments, not evidence of implemented behavior. They have their own sidebar category.
• Implementation records: migration steps, plans and discrepancies to verify. Read the corresponding current design first; historical records do not establish current implementation status.
• Research: exploratory proposals, threat analysis and evaluation notes, not product commitments.

Maintenance rules#

Every page has one sidebar category. Register new pages and their reading order in scripts/docs_site/nav.py; unclassified pages remain visible in an Uncategorized group. Category changes preserve page URLs.

Maintain one current design per topic. Diagrams, comparisons and implementation records should explain their relationship to that design without copying its body. Default sources are English with synchronized Chinese counterparts. See documentation conventions.

Documentation claims, source presence, passing tests, publication and installed-App acceptance are separate states. Categories do not indicate implementation completeness.