Skip to content

docs(documentation): Update server docs for v5 architecture - #1510

Open
RandomByte wants to merge 1 commit into
mainfrom
docs/server-v5-architecture
Open

docs(documentation): Update server docs for v5 architecture#1510
RandomByte wants to merge 1 commit into
mainfrom
docs/server-v5-architecture

Conversation

@RandomByte

@RandomByte RandomByte commented Aug 7, 2026

Copy link
Copy Markdown
Member

Reflect the new UI5 Server architecture in the user-facing docs.

Server.md: The watch-mode section claimed config files are not monitored and that config changes require a restart. The Supervisor and ProjectDefinitionWatcher now re-resolve the graph and re-create the serving stack behind a stable HTTP server on a definition change. Split the section: keep source monitoring under Watch Mode Behavior, add a Project Definition Changes section covering ui5.yaml / package.json / workspace config / --config / --dependency-definition watching and the git checkout case. Requests are held with an auto-reloading page while the graph re-resolves. The restart caveat now scopes to custom task and middleware implementation code.

index.md: Add Node.js API examples for starting a server via serve() and for embedding the middleware via serveMiddleware().

JIRA: CPOUI5FOUNDATION-1307

Reflect the new UI5 Server architecture in the user-facing docs.

Server.md: The watch-mode section claimed config files are not monitored
and that config changes require a restart. The Supervisor and
ProjectDefinitionWatcher now re-resolve the graph and re-create the
serving stack behind a stable HTTP server on a definition change. Split
the section: keep source monitoring under Watch Mode Behavior, add a
Project Definition Changes section covering ui5.yaml / package.json /
workspace config / --config / --dependency-definition watching and the
git checkout case. Requests are held with an auto-reloading page while
the graph re-resolves. The restart caveat now scopes to custom task and
middleware implementation code.

index.md: Add Node.js API examples for starting a server via serve() and
for embedding the middleware via serveMiddleware().
@RandomByte
RandomByte requested review from a team and KlattG August 7, 2026 09:12
@RandomByte
RandomByte marked this pull request as ready for review August 7, 2026 09:12

#### Embedding the Middleware

`serveMiddleware` assembles the UI5 middleware as a single connect/Express handler, for mounting into an HTTP server you own instead of starting one. It does not bind a port or attach the Live Reload WebSocket server.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`serveMiddleware` assembles the UI5 middleware as a single connect/Express handler, for mounting into an HTTP server you own instead of starting one. It does not bind a port or attach the Live Reload WebSocket server.
`serveMiddleware` assembles the UI5 middleware as a single connect/Express handler for mounting into an HTTP server you own instead of starting one. It does not bind a port or attach the LiveReload WebSocket server.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants