qqeasonchen opened a new pull request, #5326: URL: https://github.com/apache/eventmesh/pull/5326
## What Closes #5306 — documentation synced with implementation status via a **canonical capability status table** in the main README (EN + zh-CN), with every module doc pointing at it. ## Why README, redesign docs, A2A docs and production-readiness docs each describe different architectural stages. Status words like "experimental" or "legacy" appear ad hoc — the A2A banner says Experimental, the client guide says legacy TCP SDKs are retained, production-readiness lists verified capabilities — but nowhere defines what these levels mean or which capability is at which level. New users cannot tell the recommended path from the compatibility surface. ## What changes ### README.md / README.zh-CN.md — new "Capability status" section The **single source of truth** (exactly the table proposed in the issue): | Capability | Status | Recommendation | Migration target | |---|:---:|---|---| | HTTP + CloudEvents | **GA target** | Recommended — primary user path (`CloudEventsClient` + `/events/*`) | Primary path | | Kafka / RocketMQ storage (4.x, 5.x) | **GA target** | Recommended — pluggable WAL backends, TCK-covered (`MeshStoragePluginTCK`, #5303) | Primary path | | SSE / WebSocket push | **Beta** | Usable — integration-tested; unified ACK/redelivery semantics still landing | Unified push transports | | Connector Runtime | **Beta** | Usable — 24 connector plugins on the standalone runtime | New connector SPI migration | | A2A / Agent Gateway | **Experimental** | Evaluate — task store + runtime bridge landed (#5302/#5304); reaper & Meta-backed agent cards pending (D2) | Unified Runtime A2A | | TCP / gRPC / OpenMessaging SDKs | **Legacy-compatible** | Existing users only — zero-change compat, not extended | HTTP + CloudEvents | Plus a definition block for each level (GA target / Beta / Experimental / Legacy-compatible) so every term means one thing across all docs, and a migration pointer for TCP/gRPC users to `CloudEventsClient`. ### Module docs link the table instead of restating status | Doc | Change | |---|---| | `docs/a2a-protocol/README.md` | Existing EXPERIMENTAL banner now cites the table as the canonical maturity level | | `docs/eventmesh-cloudevents-client-guide.md` | Legacy SDK note links the table (HTTP+CE = GA, TCP/gRPC = legacy) | | `docs/production-readiness.md` | Scope note before §2: status/recommendation/migration live in the table; this doc keeps verification & ops detail | | `docs/eventmesh-uni-architecture-redesign.md` | Header marked as historical design record; current status in the table | | `docs/eventmesh-offset-lb-frame-design.md` | Same historical-record note | ## Acceptance criteria (#5306) - [x] A single, linked status table is maintained in the main README (EN + zh-CN, same content) - [x] Each module's docs state status/recommendation/migration target consistently — by linking the table rather than duplicating - [x] "Legacy" / "Experimental" notes now resolve against the table's defined levels ## Notes for reviewers - Pure documentation change: 7 files, **+64 / −0** (insertions only — no restructuring of existing text) - Status assignments reflect the current tree: storage TCK landed in #5323, A2A gateway persisted tasks + security gate in #5324; SSE/WS and Connector Runtime verified by integration tests in `production-readiness.md` but their semantics/SPI are still converging, hence Beta - The table is meant to be updated as capabilities graduate — one row edit in one file -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
