Skip to content

docs: add architecture, transports and monolog documentation#165

Open
guillaumedelre wants to merge 1 commit into
bzikarsky:masterfrom
guillaumedelre:feature/issue-25
Open

docs: add architecture, transports and monolog documentation#165
guillaumedelre wants to merge 1 commit into
bzikarsky:masterfrom
guillaumedelre:feature/issue-25

Conversation

@guillaumedelre

Copy link
Copy Markdown

Closes #25

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>
@guillaumedelre

Copy link
Copy Markdown
Author

Hey @bzikarsky, this PR fixes #25 — happy to adjust if anything looks off.

@guillaumedelre

Copy link
Copy Markdown
Author

Hey @bzikarsky, just a gentle ping on this one. Happy to rebase or adjust if needed.

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.

Extensive documentation

1 participant