docs(event-handler): general improvements #4517
Merged
+794
−282
Conversation
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
pull-request-size
bot
added
the
size/XXL
boring-cyborg
bot
added
the
documentation
svozza
reviewed
Sep 20, 2025
|
Two very minor comments but other than that LGTM! |
Co-authored-by: Stefano Vozza <[email protected]>
|
svozza
approved these changes
Sep 22, 2025
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.
Summary
Changes
This PR improves the Event Handler docs by adding descriptions and examples for all features currently supported, as well as providing some light descriptions - and in some cases workarounds - for features we don't support yet. For the latter, I also link to the relevant issue so that readers can follow along with the progress.
For the most part, except a couple minor cases, the code examples reflect the current state of the Event Handler. There are however at least 2 code snippets that currently have linting issues which will be solved by issues we're already working on early next/this week.
In cases where features we added like compression and cors made the examples obsolete, I took the liberty to update the code examples with new content.
I suggest reviewers to pull the branch and run the docs locally to review effectively.
Issue number: closes #4475
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.