docs: fold reference/ into feature/, split offset-lb-frame into three EN pages, rewrite redesign.md in English - #5391
Merged
qqeasonchen merged 1 commit intoSep 10, 2026
Conversation
… EN pages, rewrite redesign.md in English Follow-up to apache#5390 folding the tree further per review: - reference/ (7 pages) merged into feature/: client-java, http-api, admin-api, observability, deployment, protocols, storage-spi - architecture/connector-api-split.md and architecture/control-plane.md moved to feature/ (capability/mechanism pages) - architecture/offset-lb-frame.md (Chinese) split into three English feature pages: offset-management.md (two offset layers, deferred ACK, monotonic writes, takeover), load-balancing.md (full-stickiness model, self-reported load, recommend loop), frame-protocol.md (EventMeshFrame wire format, FrameAdaptor/WireCodec SPIs, per-protocol chains) - architecture/redesign.md rewritten in English as a design record (executive summary, iron rules, target architecture, decision log 15.1-15.8, at-least-once vs exactly-once boundary, request-reply, streaming; historical appendices folded into current docs) docs/ is now: quickstart/ + feature/ + architecture/ (overview, security, redesign, review/) + index/introduction. All 199 internal .md links validated resolving.
qqeasonchen
added a commit
that referenced
this pull request
Sep 10, 2026
) Follow-up to #5390/#5391 sweeping every place outside docs/ that still referenced the old flat doc names: - README.zh-CN.md: capability table + doc nav rewritten to the new quickstart/feature/architecture layout (mirrors the EN README map) - CONTRIBUTING.md: arch-guard and storage-SPI matrix links - docker/Dockerfile: deployment-mode note -> docs/feature/deployment.md - eventmesh.properties (+dist copy): Connector Runtime section comment -> docs/feature/deployment.md - DistributionMode javadoc -> docs/architecture/redesign.md - sdk-java build.gradle OMA comment -> docs/feature/protocols.md - sdk legacy-README.md links - docs/**: link display text and prose mentions still naming old files (evidence.md, production-ha-plan.md, overview.md, client-java.md, protocols.md, control-plane.md, a2a-readiness.md, architecture-guard.md) Repo-wide scan now finds zero stale references (the only remaining docs/reference/ strings are opentelemetry.io spec URLs, untouched). All 227 internal .md links across docs/ + READMEs + CONTRIBUTING resolve. Touched modules compile and pass checkstyleMain.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #5390 — folds the tree further per review feedback.
Motivation
Consolidate the docs layout:
reference/merges intofeature/; the Chineseoffset-lb-framedesign page splits into three English feature pages; two architecture mechanism pages move tofeature/;redesign.mdbecomes English.Changes
reference/ → feature/ (7 pages)
client-java·http-api·admin-api·observability·deployment·protocols·storage-spi— allgit mv'd with history.architecture → feature (2 pages)
connector-api-split.md— the connector API split plan (a capability/mechanism page)control-plane.md— delivery topology + state control plane + absorbed failure matrixoffset-lb-frame.md (中文, 391 lines) → three English feature pages
feature/offset-management.mdfeature/load-balancing.mdLoadMeter), the/session/recommendscoring loop, session-granularity pinning, accepted trade-offsfeature/frame-protocol.mdEventMeshFramewire format (14B header + KV + data), msgType field mapping,FrameAdaptorSPI,WireCodecSPI, complete ingress/egress conversion chains for CloudEvents / MeshMessage / A2A, storage SPI frame handlingredesign.md → English
The 5,248-line Chinese design record is rewritten as a focused English design record: executive summary, the six iron rules (+ status snapshot), target architecture diagram, storage/SDK/ingress/egress/connector redesign summaries, the v1.2 decision log (15.1–15.8), the at-least-once vs exactly-once layer boundary, request-reply semantics, and the streaming modes — with cross-links into the current feature pages and a note that the historical appendices' live content now lives in the feature tree.
Result
Verification
.mdlinks validated resolving (0 broken) acrossdocs/**+ README.