docs(documentation): Update server docs for v5 architecture - #1510
Open
RandomByte wants to merge 1 commit into
Open
docs(documentation): Update server docs for v5 architecture#1510RandomByte wants to merge 1 commit into
RandomByte wants to merge 1 commit into
Conversation
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
marked this pull request as ready for review
August 7, 2026 09:12
KlattG
requested changes
Aug 7, 2026
|
|
||
| #### 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. |
Contributor
There was a problem hiding this comment.
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. |
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.
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