docs: document using FrankenPHP as a Go library#2531
Open
nicolas-grekas wants to merge 1 commit into
Open
Conversation
The Server refactor introduces new public API (NewServer, WithServer, Server.ServeHTTP, WithWorkerServerScope, WithWorkerMatcher) that had no documentation outside of godoc. Adds a docs page covering the library flow, multiple servers, worker scoping, per-request options and the compatibility path for the pre-Server API.
alexandre-daubois
left a comment
alexandre-daubois
left a comment
Member
There was a problem hiding this comment.
Nice! We should wait for #2499 to be stabilized. Or is it already?
alexandre-daubois
approved these changes
Jul 20, 2026
Contributor
|
This doesn't necessarily be part of #2499, but we can merge it in 👍 |
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
3 participants
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 #2499, targeting
refactor/phpserver. Docs-only.The refactor introduces new public API for library users (
NewServer,WithServer,Server.ServeHTTP,WithWorkerServerScope,WithWorkerMatcher) with no documentation outside godoc. This adds adocs/library.mdpage covering:NewServer+Init(WithServer(...))+Server.ServeHTTPas anhttp.Handlerphp_serverblocks)ServeHTTP()keeps working through the fallback serverAlso linked from the README docs list and
llms.txt. The examples follow the currentNewServersignature on the branch; if #2529 lands first, the snippets need a one-line update (happy to rebase either way). Translations are left to the usual translation update flow.