docs/README.en.md

Rama main · réplica de lectura del repositorio original.

# Documentation Map

This directory contains public documentation for the open-source BailingHub project. Internal operations notes, official website planning, and temporary research reports do not belong in the open-source package.

## Getting Started

| Document | Purpose |
|---|---|
| [RELEASE_NOTES_v0.10.1.en.md](RELEASE_NOTES_v0.10.1.en.md) · [Chinese](RELEASE_NOTES_v0.10.1.md) | v0.10.1: explicit declaration values, Core precedence and companion-package verification. |
| [UPGRADE_v0.10.1.en.md](UPGRADE_v0.10.1.en.md) · [Chinese](UPGRADE_v0.10.1.md) | No new SQL; generator/consumer pairing, full declaration diffs and rollback boundaries. |
| [RELEASE_NOTES_v0.10.0.en.md](RELEASE_NOTES_v0.10.0.en.md) · [Chinese](RELEASE_NOTES_v0.10.0.md) | v0.10.0: on-demand knowledge, console consistency, larger arguments and model budgets. |
| [UPGRADE_v0.10.0.en.md](UPGRADE_v0.10.0.en.md) · [Chinese](UPGRADE_v0.10.0.md) | No new SQL from 0.9.4; readiness, client pairing, explicit policies and rollback. |
| [AGENT_KNOWLEDGE_API.en.md](AGENT_KNOWLEDGE_API.en.md) · [Chinese](AGENT_KNOWLEDGE_API.md) | Agent-only knowledge hints, search, authorized references and bounded reads. |
| [MODEL_OUTPUT_BUDGET.en.md](MODEL_OUTPUT_BUDGET.en.md) · [Chinese](MODEL_OUTPUT_BUDGET.md) | Default budgets, service ceilings, provider parameters and reasoning scope. |
| [MODEL_CONTINUATION.en.md](MODEL_CONTINUATION.en.md) · [Chinese](MODEL_CONTINUATION.md) | Host continuation, original-operation recovery and tool deduplication. |
| [IMPLEMENTATION_STATUS.en.md](IMPLEMENTATION_STATUS.en.md) · [Chinese](IMPLEMENTATION_STATUS.md) | Core ownership, formal releases versus main, public evidence, and uncovered scope. |
| [RELEASE_NOTES_v0.9.4.en.md](RELEASE_NOTES_v0.9.4.en.md) · [Chinese](RELEASE_NOTES_v0.9.4.md) | v0.9.4: DOCX dependency remediation, durable notifications and console recovery. |
| [UPGRADE_v0.9.4.en.md](UPGRADE_v0.9.4.en.md) · [Chinese](UPGRADE_v0.9.4.md) | Explicit migration 068, state/configuration databases, event deduplication and rollback limits. |
| [NOTIFICATION_DURABILITY.en.md](NOTIFICATION_DURABILITY.en.md) · [Chinese](NOTIFICATION_DURABILITY.md) | Notification persistence, recovery, operator actions, persistent metrics and external delivery limits. |
| [DOCX_DEPENDENCY.en.md](DOCX_DEPENDENCY.en.md) · [Chinese](DOCX_DEPENDENCY.md) | Pinned Mammoth library provenance, CLI-chain removal and strict auditing. |
| [RELEASE_NOTES_v0.9.3.en.md](RELEASE_NOTES_v0.9.3.en.md) · [Chinese](RELEASE_NOTES_v0.9.3.md) | v0.9.3: bounded bodies, graceful notification close and original-notification DLQ replay, with maintenance metrics. |
| [UPGRADE_v0.9.3.en.md](UPGRADE_v0.9.3.en.md) · [Chinese](UPGRADE_v0.9.3.md) | Explicit migration 067, matching DLQ/state adapters, rollback manifests and preserved markers. |
| [RELEASE_NOTES_v0.9.2.en.md](RELEASE_NOTES_v0.9.2.en.md) · [Chinese](RELEASE_NOTES_v0.9.2.md) | v0.9.2: secure installation, automatic settlement and original approval continuation, with deployment diagnostics and process tests. |
| [UPGRADE_v0.9.2.en.md](UPGRADE_v0.9.2.en.md) · [Chinese](UPGRADE_v0.9.2.md) | Explicit migrations 065/066, matching adapters, original-record checks and rollback limits. |
| [CORE_RELIABILITY.en.md](CORE_RELIABILITY.en.md) · [Chinese](CORE_RELIABILITY.md) | Installation credentials, settlement/approval continuation, bounded bodies, notification close/replay and synthetic acceptance boundaries. |
| [RELEASE_NOTES_v0.9.1.en.md](RELEASE_NOTES_v0.9.1.en.md) · [Chinese](RELEASE_NOTES_v0.9.1.md) | v0.9.1: asynchronous usage shutdown fix, public capability index, and general security governance. |
| [UPGRADE_v0.9.1.en.md](UPGRADE_v0.9.1.en.md) · [Chinese](UPGRADE_v0.9.1.md) | 0.9.0 patch upgrade, original requests, artifact manifests, and shutdown acceptance; no new SQL/APIs. |
| [RELEASE_NOTES_v0.9.0.en.md](RELEASE_NOTES_v0.9.0.en.md) · [Chinese](RELEASE_NOTES_v0.9.0.md) | v0.9.0: optional model billing, shared allowances and image tools. |
| [UPGRADE_v0.9.0.en.md](UPGRADE_v0.9.0.en.md) · [Chinese](UPGRADE_v0.9.0.md) | Upgrade from public 0.8.0, migrations 063/064 and optional host integration. |
| [MODEL_BILLING.en.md](MODEL_BILLING.en.md) · [Chinese](MODEL_BILLING.md) | Models/tools, reference prices, asynchronous settlement, archive and allowance reset contract. |
| [PERIOD_ALLOWANCE_UPGRADE.en.md](PERIOD_ALLOWANCE_UPGRADE.en.md) · [Chinese](PERIOD_ALLOWANCE_UPGRADE.md) | Separate periodic price/allowance and migrate existing preview snapshots. |
| [RELEASE_NOTES_v0.8.0.md](RELEASE_NOTES_v0.8.0.md) · [English](RELEASE_NOTES_v0.8.0.en.md) | v0.8.0: long tasks, original receipts, attachments and upgrade boundaries. |
| [RELEASE_NOTES_v0.7.0.md](RELEASE_NOTES_v0.7.0.md) · [English](RELEASE_NOTES_v0.7.0.en.md) | v0.7.0 shop/inventory scenarios, upgrade steps and limits. |
| [user-guide/conversations.en.md](user-guide/conversations.en.md) | Multi-account conversations, full-text review and offline recovery for users. |
| [QUICKSTART.en.md](QUICKSTART.en.md) | Install BailingHub, run the Docker demo, create the first route, and connect the first business tool. |
| [DEMO.en.md](DEMO.en.md) | Docker demo walkthrough: hub, MySQL, demo business system, tool provider, audit, and trace. |
| [INDEPENDENT_VALIDATION.en.md](INDEPENDENT_VALIDATION.en.md) | Independent Docker demo task with objective pass criteria and a standard report path. |
| [INDEPENDENT_VALIDATION.md](INDEPENDENT_VALIDATION.md) | Chinese independent validation task. |
| [AGENT_CLIENT_QUICKSTART.en.md](AGENT_CLIENT_QUICKSTART.en.md) | End-to-end Agent Client setup and configuration ownership. |
| [AGENT_CLIENT_QUICKSTART.md](AGENT_CLIENT_QUICKSTART.md) | Chinese Agent Client integration guide. |
| [LOCAL_AGENT_SETUP.en.md](LOCAL_AGENT_SETUP.en.md) | Four-step console setup: authorization, descriptions, tools/approvals, and connection checks. |
| [LOCAL_AGENT_SETUP.md](LOCAL_AGENT_SETUP.md) | Chinese local-agent setup guide. |
| [AGENT_SYSTEM_INFO.en.md](AGENT_SYSTEM_INFO.en.md) | Controlled descriptions before first tool discovery, with original binding and compatibility rules. |
| [AGENT_SYSTEM_INFO.md](AGENT_SYSTEM_INFO.md) | Chinese system-information contract. |
| [AGENT_SUBJECT_DISPLAY.en.md](AGENT_SUBJECT_DISPLAY.en.md) | Business authorization display names: responsibilities, new approvals and existing-session synchronization. |
| [AGENT_AUTH_API.en.md](AGENT_AUTH_API.en.md) | Agent Auth v1, PKCE, trusted business identity, and revocation. |
| [AGENT_AUTH_API.md](AGENT_AUTH_API.md) | Chinese Agent Auth v1 protocol. |
| [INVOCATION_RECEIPTS.md](INVOCATION_RECEIPTS.md) | Read an original receipt without continuing its business operation. |
| [AGENT_CLIENT_RUNTIME_API.en.md](AGENT_CLIENT_RUNTIME_API.en.md) | Agent Client Runtime v1 workspaces, turns, tools, and completion contract. |
| [AGENT_TASK_CONTROL.en.md](AGENT_TASK_CONTROL.en.md) · [Chinese](AGENT_TASK_CONTROL.md) | Core 0.8.0: cumulative task budgets, actual dispatch, pause and SDK/DSH host integration. |
| [AGENT_CLIENT_RUNTIME_API.md](AGENT_CLIENT_RUNTIME_API.md) | Chinese Agent Client Runtime v1 contract. |
| [AGENT_CONVERSATION_AUDIT.en.md](AGENT_CONVERSATION_AUDIT.en.md) | Complete visible conversation audit, member confirmation, run ownership and admin pagination. |
| [AGENT_CONVERSATION_AUDIT.md](AGENT_CONVERSATION_AUDIT.md) | Chinese complete conversation audit protocol. |
| [user-guide/README.en.md](user-guide/README.en.md) | User and product-owner guide: business goals, console concepts, and scenario-based setup. |
| [CONTRACT.en.md](CONTRACT.en.md) | Stable HTTP and wire contract between business systems and the hub. |
| [INTEGRATION.en.md](INTEGRATION.en.md) | Third-party integration guide for tools, signatures, authorization, and callback handling. |
| [WIDGET_RENDERERS.en.md](WIDGET_RENDERERS.en.md) | Trusted rich-content renderer extension for charts and interactive reports in the chat widget. |
| [WIDGET_RENDERERS.md](WIDGET_RENDERERS.md) | Chinese trusted widget renderer guide. |
| [integrations/dify/README.en.md](integrations/dify/README.en.md) | Minimal Dify integration through the governed BailingHub `/run` and `/jobs/{job_id}` APIs. |
| [integrations/dify/README.md](integrations/dify/README.md) | Chinese Dify + BailingHub minimal integration recipe. |
| [integrations/deepseek/README.en.md](integrations/deepseek/README.en.md) | DeepSeek V4 + BailingHub bilingual E2E recipe with thinking-mode tool-call compatibility. |
| [integrations/deepseek/README.md](integrations/deepseek/README.md) | Chinese DeepSeek V4 + BailingHub E2E recipe. |
| [integrations/bailian/README.en.md](integrations/bailian/README.en.md) | Alibaba Cloud Model Studio custom MCP recipe for governed BailingHub jobs. |
| [integrations/bailian/README.md](integrations/bailian/README.md) | Chinese Alibaba Cloud Model Studio + BailingHub custom MCP recipe. |
| [integrations/ruoyi-vue-pro/README.en.md](integrations/ruoyi-vue-pro/README.en.md) | Authority-preserving RuoYi-Vue-Pro after-sale and refund integration recipe. |
| [integrations/ruoyi-vue-pro/README.md](integrations/ruoyi-vue-pro/README.md) | Chinese RuoYi-Vue-Pro / Yudao community integration recipe. |
| [integrations/jeecgboot/README.en.md](integrations/jeecgboot/README.en.md) | Authority-preserving JeecgBoot user read and freeze/unfreeze integration recipe. |
| [integrations/jeecgboot/README.md](integrations/jeecgboot/README.md) | Chinese JeecgBoot governed user-action community integration recipe. |

## Architecture And Models

| Document | Purpose |
|---|---|
| [ARCHITECTURE.en.md](ARCHITECTURE.en.md) | Architecture overview: layers, runtime path, boundaries, and extension points. |
| [KERNEL_HOST_API.en.md](KERNEL_HOST_API.en.md) | Versioned high-level embedding API, managed lifecycle, mount paths, and artifact upgrade boundary. |
| [MODEL_PROCESS_RECOVERY.en.md](MODEL_PROCESS_RECOVERY.en.md) · [简体中文](MODEL_PROCESS_RECOVERY.md) | Opt-in process-crash/lost-acknowledgement regressions included in v0.9.2; historical Tag evidence stays separate. |
| [KERNEL_HOST_API.md](KERNEL_HOST_API.md) | Chinese Kernel Host API guide. |
| [PIPELINE.en.md](PIPELINE.en.md) | Runtime pipeline from trigger to dispatch, tools, audit, approval, and delivery. |

## Runtime Capabilities

| Document | Purpose |
|---|---|
| [TOOLS_MODEL.en.md](TOOLS_MODEL.en.md) | Unified tool definition model across OpenAPI, SDK, overlays, and future adapters. |
| [TOOLS_DESIGN.en.md](TOOLS_DESIGN.en.md) | Tool governance design: allowlists, risk, rate limits, approvals, audit, and signatures. |
| [AI_FRIENDLY_TOOLS.en.md](AI_FRIENDLY_TOOLS.en.md) | How to design business APIs as AI-friendly tools without exposing raw backend CRUD. |
| [TOOLS.en.md](TOOLS.en.md) | Practical tool provider and governance guide. |
| [SDK.en.md](SDK.en.md) | SDK guide for PHP, Node, Python, Java, Go, .NET, and any-language OpenAPI/HMAC integration. |
| [CHANNELS.en.md](CHANNELS.en.md) | Inbound channel model and adapter expectations. |
| [OPERATIONS.en.md](OPERATIONS.en.md) | Production topology, readiness, capacity, upgrades, backups, and recovery. |
| [DEPLOYMENT_DIAGNOSTICS.en.md](DEPLOYMENT_DIAGNOSTICS.en.md) · [Chinese](DEPLOYMENT_DIAGNOSTICS.md) | Read-only deployment doctor: public identities, explicit readiness, unknown/unchecked evidence and machine exit codes. |
| [STREAMING.en.md](STREAMING.en.md) | Chat streaming protocol, reconnect behavior, canonical final result, and multi-replica boundary. |
| [STREAMING.md](STREAMING.md) | Chinese chat streaming protocol. |

## Release And Maintenance

| Document | Purpose |
|---|---|
| [ECOSYSTEM.en.md](ECOSYSTEM.en.md) | Policy for community distributions, independent implementations, and future ecosystem listings. |
| [ECOSYSTEM.md](ECOSYSTEM.md) | Chinese ecosystem and derivatives policy. |
| [RELEASE_NOTES_v0.1.1.en.md](RELEASE_NOTES_v0.1.1.en.md) | `v0.1.1` release notes for widget operations and stricter integration boundaries. |
| [RELEASE_NOTES_v0.1.1.md](RELEASE_NOTES_v0.1.1.md) | Chinese `v0.1.1` release notes. |
| [RELEASE_NOTES_v0.1.2.en.md](RELEASE_NOTES_v0.1.2.en.md) | `v0.1.2` server-token and derived-credential security hardening. |
| [RELEASE_NOTES_v0.1.2.md](RELEASE_NOTES_v0.1.2.md) | Chinese `v0.1.2` release notes. |
| [RELEASE_NOTES_v0.1.3.en.md](RELEASE_NOTES_v0.1.3.en.md) | `v0.1.3` portable executor onboarding and OpenClaw adapter release notes. |
| [RELEASE_NOTES_v0.1.3.md](RELEASE_NOTES_v0.1.3.md) | Chinese `v0.1.3` release notes. |
| [RELEASE_NOTES_v0.1.4.en.md](RELEASE_NOTES_v0.1.4.en.md) | `v0.1.4` real web chat streaming and reconnectable SSE release notes. |
| [RELEASE_NOTES_v0.1.4.md](RELEASE_NOTES_v0.1.4.md) | Chinese `v0.1.4` release notes. |
| [RELEASE_NOTES_v0.1.5.en.md](RELEASE_NOTES_v0.1.5.en.md) | `v0.1.5` installer reliability and clean-server compatibility release notes. |
| [RELEASE_NOTES_v0.1.5.md](RELEASE_NOTES_v0.1.5.md) | Chinese `v0.1.5` release notes. |
| [RELEASE_NOTES_v0.1.6.en.md](RELEASE_NOTES_v0.1.6.en.md) | `v0.1.6` independent-validation and post-install privilege-hint release notes. |
| [RELEASE_NOTES_v0.1.6.md](RELEASE_NOTES_v0.1.6.md) | Chinese `v0.1.6` release notes. |
| [RELEASE_NOTES_v0.1.7.en.md](RELEASE_NOTES_v0.1.7.en.md) | `v0.1.7` versioned Client API and cross-ecosystem compatibility-gate release notes. |
| [RELEASE_NOTES_v0.1.7.md](RELEASE_NOTES_v0.1.7.md) | Chinese `v0.1.7` release notes. |
| [RELEASE_NOTES_v0.1.8.en.md](RELEASE_NOTES_v0.1.8.en.md) | `v0.1.8` create-once initial-admin bootstrap release notes. |
| [RELEASE_NOTES_v0.1.8.md](RELEASE_NOTES_v0.1.8.md) | Chinese `v0.1.8` release notes. |
| [RELEASE_NOTES_v0.1.9.en.md](RELEASE_NOTES_v0.1.9.en.md) | `v0.1.9` optional OpenMetrics operational metrics release notes. |
| [RELEASE_NOTES_v0.1.9.md](RELEASE_NOTES_v0.1.9.md) | Chinese `v0.1.9` release notes. |
| [RELEASE_NOTES_v0.1.10.en.md](RELEASE_NOTES_v0.1.10.en.md) | `v0.1.10` instance branding, model identifier diagnostics, and ecosystem recipe release notes. |
| [RELEASE_NOTES_v0.1.10.md](RELEASE_NOTES_v0.1.10.md) | Chinese `v0.1.10` release notes. |
| [RELEASE_NOTES_v0.1.11.en.md](RELEASE_NOTES_v0.1.11.en.md) | `v0.1.11` side-effect execution journal and uncertain-outcome freezing release notes. |
| [RELEASE_NOTES_v0.1.11.md](RELEASE_NOTES_v0.1.11.md) | Chinese `v0.1.11` release notes. |
| [RELEASE_NOTES_v0.1.12.en.md](RELEASE_NOTES_v0.1.12.en.md) | `v0.1.12` voice transcription policy and fail-closed audio handling release notes. |
| [RELEASE_NOTES_v0.1.12.md](RELEASE_NOTES_v0.1.12.md) | Chinese `v0.1.12` release notes. |
| [RELEASE_NOTES_v0.1.13.en.md](RELEASE_NOTES_v0.1.13.en.md) | `v0.1.13` voice transcription and distribution-version alignment release notes. |
| [RELEASE_NOTES_v0.1.13.md](RELEASE_NOTES_v0.1.13.md) | Chinese `v0.1.13` release notes. |
| [RELEASE_NOTES_v0.1.14.en.md](RELEASE_NOTES_v0.1.14.en.md) | `v0.1.14` transient progress feedback for streaming chat release notes. |
| [RELEASE_NOTES_v0.1.14.md](RELEASE_NOTES_v0.1.14.md) | Chinese `v0.1.14` release notes. |
| [RELEASE_NOTES_v0.1.15.en.md](RELEASE_NOTES_v0.1.15.en.md) | `v0.1.15` trusted rich rendering and chat reliability release notes. |
| [RELEASE_NOTES_v0.1.15.md](RELEASE_NOTES_v0.1.15.md) | Chinese `v0.1.15` release notes. |
| [RELEASE_NOTES_v0.1.16.en.md](RELEASE_NOTES_v0.1.16.en.md) | `v0.1.16` bounded tool runtime and resilient semantic retrieval release notes. |
| [RELEASE_NOTES_v0.1.16.md](RELEASE_NOTES_v0.1.16.md) | Chinese `v0.1.16` release notes. |
| [RELEASE_NOTES_v0.2.0.en.md](RELEASE_NOTES_v0.2.0.en.md) | `v0.2.0` tool catalog access protection and active verification release notes. |
| [RELEASE_NOTES_v0.2.0.md](RELEASE_NOTES_v0.2.0.md) | Chinese `v0.2.0` release notes. |
| [RELEASE_NOTES_v0.3.0.en.md](RELEASE_NOTES_v0.3.0.en.md) | `v0.3.0` composable Core and Kernel Host API v1 release notes. |
| [RELEASE_NOTES_v0.3.0.md](RELEASE_NOTES_v0.3.0.md) | Chinese `v0.3.0` release notes. |
| [RELEASE_NOTES_v0.3.1.en.md](RELEASE_NOTES_v0.3.1.en.md) | `v0.3.1` PDF parsing security update. |
| [RELEASE_NOTES_v0.3.1.md](RELEASE_NOTES_v0.3.1.md) | Chinese `v0.3.1` release notes. |
| [RELEASE_NOTES_v0.3.2.en.md](RELEASE_NOTES_v0.3.2.en.md) | `v0.3.2` managed demo dataset onboarding. |
| [RELEASE_NOTES_v0.3.2.md](RELEASE_NOTES_v0.3.2.md) | Chinese `v0.3.2` release notes. |
| [RELEASE_NOTES_v0.3.3.en.md](RELEASE_NOTES_v0.3.3.en.md) | `v0.3.3` npm publication provenance-metadata correction. |
| [RELEASE_NOTES_v0.3.3.md](RELEASE_NOTES_v0.3.3.md) | Chinese `v0.3.3` release notes. |
| [RELEASE_NOTES_v0.3.4.en.md](RELEASE_NOTES_v0.3.4.en.md) | `v0.3.4` anonymous-preview and trusted-business-identity guidance. |
| [RELEASE_NOTES_v0.3.4.md](RELEASE_NOTES_v0.3.4.md) | Chinese `v0.3.4` release notes. |
| [RELEASE_NOTES_v0.5.0.en.md](RELEASE_NOTES_v0.5.0.en.md) | `v0.5.0` revocable local-Agent authorization and governed local planning. |
| [RELEASE_NOTES_v0.5.0.md](RELEASE_NOTES_v0.5.0.md) | Chinese `v0.5.0` release notes. |
| [RELEASE_NOTES_v0.5.1.en.md](RELEASE_NOTES_v0.5.1.en.md) | `v0.5.1` Agent Client management center and bulk write-operation configuration. |
| [RELEASE_NOTES_v0.6.1.en.md](RELEASE_NOTES_v0.6.1.en.md) | `v0.6.1`: follow a conversation through its business actions, with compatible multi-account clients. |
| [RELEASE_NOTES_v0.6.0.en.md](RELEASE_NOTES_v0.6.0.en.md) | `v0.6.0`: follow a conversation through its business actions, with compatible multi-account clients. |
| [RELEASE_NOTES_v0.6.1.md](RELEASE_NOTES_v0.6.1.md) | Chinese `v0.6.1` release notes and upgrade guide. |
| [RELEASE_NOTES_v0.6.0.md](RELEASE_NOTES_v0.6.0.md) | Chinese `v0.6.0` release notes and upgrade guide. |
| [RELEASE_NOTES_v0.5.1.md](RELEASE_NOTES_v0.5.1.md) | Chinese `v0.5.1` release notes. |
| [RELEASE_NOTES_v0.1.0.en.md](RELEASE_NOTES_v0.1.0.en.md) | First public release notes. |
| [CHANGELOG.en.md](CHANGELOG.en.md) | Public changelog format and current release summary. |
| [COMPATIBILITY.en.md](COMPATIBILITY.en.md) | Versioning, compatibility, migration, and schema discipline. |

## Maintenance Rules

- Every public Chinese document should have an English companion document unless it is explicitly internal and excluded from the open-source package.
- Public contract changes must update the contract docs, SDK examples, and changelog together.
- Internal decision logs, release rehearsals, and website/console UX rules belong under `internal/`, not in the public package.
- Temporary discussion material should not be added here unless it has become maintained public documentation.