Skip to content

docs: refresh README for shipped Doctrine + Symfony bundle#5

Merged
webmen-development merged 1 commit into
mainfrom
docs/refresh-readme-bundle-status
Jun 1, 2026
Merged

docs: refresh README for shipped Doctrine + Symfony bundle#5
webmen-development merged 1 commit into
mainfrom
docs/refresh-readme-bundle-status

Conversation

@erikfrerejean

Copy link
Copy Markdown
Member

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:

  • Status note — replaced the stale "core-only" claim with the bundle's actual scope (framework-free core + Doctrine/Symfony adapters), linking ADR-0009.
  • Requirements — now lists the real Symfony 8.0 + Doctrine (DBAL ^4, ORM ^3.6, doctrine-bundle ^3.2) dependencies instead of just psr/clock/psr/log.
  • Installation — adds the manual config/bundles.php registration step (no Flex recipe) and links docs/installation.md for the migration and append-only DB grant.
  • Design — adds the read side (RecordReader) to the responsibilities table.
  • Usage — notes that $recorder is bundle-autowired and points to SubjectLabeller / RecordReader wiring.

The UserRoleChanged code example was left untouched — verified still accurate against the current AbstractAuditEvent and FieldChange.

Notes

  • Install steps are deferred to docs/installation.md rather than duplicated, to avoid the two docs drifting (the config/bundles.php snippet does appear in both — small duplication surface).

Test plan

  • Docs-only change; claims verified against composer.json, the src/ tree, and docs/installation.md.

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
@webmen-development webmen-development merged commit c588500 into main Jun 1, 2026
1 check passed
@erikfrerejean erikfrerejean deleted the docs/refresh-readme-bundle-status branch June 1, 2026 07:14
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.

2 participants