docs: refresh README for shipped Doctrine + Symfony bundle#5
Merged
Merged
Conversation
The README still described the package as core-only with Doctrine persistence and the Symfony bundle yet to land. Both have shipped, so: - replace the stale status note with the bundle's actual scope (ADR-0009) - list the real Symfony 8 + Doctrine requirements - add manual bundle registration and link docs/installation.md - mention the read side (RecordReader) and SubjectLabeller wiring
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.
Summary
The README still described the package as core-only, with Doctrine persistence and the Symfony bundle "landing in subsequent releases." Both have already shipped, so the README was materially out of date.
This refreshes it to match reality:
psr/clock/psr/log.config/bundles.phpregistration step (no Flex recipe) and linksdocs/installation.mdfor the migration and append-only DB grant.RecordReader) to the responsibilities table.$recorderis bundle-autowired and points toSubjectLabeller/RecordReaderwiring.The
UserRoleChangedcode example was left untouched — verified still accurate against the currentAbstractAuditEventandFieldChange.Notes
docs/installation.mdrather than duplicated, to avoid the two docs drifting (theconfig/bundles.phpsnippet does appear in both — small duplication surface).Test plan
composer.json, thesrc/tree, anddocs/installation.md.