docs: add architecture, transports and monolog documentation#165
Open
guillaumedelre wants to merge 1 commit into
Open
docs: add architecture, transports and monolog documentation#165guillaumedelre wants to merge 1 commit into
guillaumedelre wants to merge 1 commit into
Conversation
461f41b to
1dd65ed
Compare
Add three reference files under docs/ covering the main aspects of the library that were missing from the issue checklist: - docs/architecture.md: explains the Message/Publisher/Transport layering, context serialization, exception unpacking, and custom validator injection - docs/transports.md: documents all transports (UDP, TCP, HTTP, AMQP) with their SSL and chunking options, plus the three transport wrappers (IgnoreError, Retry, KeepAliveRetry) and how to stack them - docs/monolog.md: covers standalone Monolog, Symfony (using the native type: gelf handler and whatfailuregroup instead of the verbose service approach), and Laravel; documents processors as the correct alternative to defaultContext when routing through Monolog Update README to replace the outdated Symfony YAML snippet and the HHVM section (incompatible with the PHP >= 8.0 requirement) with a quick start block and links to the new docs. Add CONTRIBUTING.md with setup steps and CI checks derived from the existing workflow. Closes bzikarsky#25 Signed-off-by: Guillaume Delre <delre.guillaume@gmail.com>
1dd65ed to
8ddc4e9
Compare
Author
|
Hey @bzikarsky, this PR fixes #25 — happy to adjust if anything looks off. |
Author
|
Hey @bzikarsky, just a gentle ping on this one. Happy to rebase or adjust if needed. |
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.
Closes #25