Skip to content

[Docs]: architecture pages still describe the pre-facade-split module ownership #4711

Description

@lidge-jun

Documentation problem type

Outdated documentation

Documentation location

docs-site/src/content/docs/reference/architecture.md (and its translated locales) plus structure/runtime.md

What is wrong or missing?

Both pages still describe the module ownership that existed before the facade splits of the last release train. Between v2.55.0 and 2.56.0, twelve large modules were split behind facades, and the architecture tree in these pages was not updated with them.

Concretely: routing now lives in src/server/index/serve-options.ts, request preparation in src/server/responses/request-prepare.ts, and bridge conversion in src/bridge/sse.ts. The pages point at the pre-split files instead. The translated locales carry the same stale description, so fixing only the English source would leave them contradicting it.

This is documentation drift, not a runtime problem — it was found during the 2.56.0 regression audit and recorded there rather than fixed inside a release change.

What should the documentation explain instead?

The architecture tree and the ownership text should name the modules that own each responsibility at the current tip, so a reader following the page lands in the file that actually contains the code. structure/transports/responses.md already carries the post-split owner inventory for the responses surface and can be used as the reference for that part.

Suggested wording or example

Use the owner table in structure/transports/responses.md ("Core module ownership") as the shape: one row per owner, one sentence of responsibility. Update the English source first, then bring ja, ko, fr, ru, tr, zh-cn and zh-tw onto it so no locale contradicts the source.

Additional context or attachments

Found during the 2.56.0 release audit; recorded in devlog/_plan/260915_2560_release_train/020_regression_audit.md among the accepted risks.

Checks

  • I searched existing documentation issues.
  • No secrets or personal information are included.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationstreamingSSE, WebSocket, terminal stream frames

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions