Skip to content

Docs review: fix outdated 4.0 examples and clean up links#862

Merged
DavidBadura merged 3 commits into
4.0.xfrom
docs/improve-and-fix-4.0-drift
Jun 15, 2026
Merged

Docs review: fix outdated 4.0 examples and clean up links#862
DavidBadura merged 3 commits into
4.0.xfrom
docs/improve-and-fix-4.0-drift

Conversation

@DavidBadura

@DavidBadura DavidBadura commented Jun 15, 2026

Copy link
Copy Markdown
Member

I went through the docs and fixed a number of code samples that still referenced classes and signatures from before 4.0. They parse fine, so it's easy to miss, but they no longer match the current src/.

The notable ones:

  • message.md still documented the removed AggregateHeader; it now uses the split-up headers (StreamNameHeader, PlayheadHeader, RecordedOnHeader).
  • store.md referenced classes that no longer exist (StreamStore, the aggregate-name/id criteria, Store\Stream) and the old string-based remove().
  • repository.md pointed at the removed RetryOutdatedAggregateCommandBus.
  • getting-started.md had an undefined $hotelProjection and an outdated bundle URL.

Besides that some smaller cleanup: added the Dynamic Consistency Boundary page to the nav (it existed but wasn't linked anywhere), renamed index.md to introduction.md, replaced a few generic "here" links, and moved the README and composer.json over to the patchlevel.dev URLs.

The architecture test change (CommandBus may depend on Identifier) was already in my working tree and is included here as well.

Checked every doc import against src/ and ran make docs-php-lint, all clean.

- Add the orphaned Dynamic Consistency Boundary page to the navigation
- Rename index.md to introduction.md per docs convention
- message.md: replace removed AggregateHeader with StreamNameHeader/PlayheadHeader/RecordedOnHeader and refresh the built-in headers list
- store.md: fix removed StreamStore/Stream/criteria classes (StreamCriterion, Store, Message\Stream, Criteria-based remove)
- repository.md: point to InstantRetryCommandBus instead of the removed RetryOutdatedAggregateCommandBus
- getting-started.md: fix undefined $hotelProjection variable and outdated bundle URL
- Replace generic [here] link anchors, fix forward references and grammar
- testing.md: add install command for the separate phpunit package
- README/composer.json: switch to patchlevel.dev canonical URLs
@DavidBadura DavidBadura requested a review from DanielBadura June 15, 2026 12:18
@DavidBadura DavidBadura changed the title docs: review pass, fix 4.0 API drift and align canonical URLs Docs review: fix outdated 4.0 examples and clean up links Jun 15, 2026
@DavidBadura DavidBadura merged commit 8a725d6 into 4.0.x Jun 15, 2026
35 of 38 checks passed
@DavidBadura DavidBadura deleted the docs/improve-and-fix-4.0-drift branch June 15, 2026 12:33
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