docs: say what mediator, CQRS and event sourcing mean - #52
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The glossary still claims it is derived from the session-context capability, which is misleading now that it defines broader concepts like CQRS and Event Sourcing.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR improves the onboarding experience in Stratara’s documentation by briefly defining Mediator, CQRS (spelled out), and Event Sourcing at their first appearance, so readers new to the patterns can understand the rest of the docs.
Changes:
- Adds a short “New to the terms?” paragraph to the top of
README.mdexpanding Mediator/CQRS/Event Sourcing and pointing to the glossary. - Adds first-class
CQRSandEvent Sourcingentries to the glossary and clarifies the Mediator entry to name the pattern first. - Adds a small “basics” strip to the landing page plus CSS styles to support the new layout.
File summaries
| File | Description |
|---|---|
| README.md | Adds brief expansions/definitions for Mediator, CQRS, and Event Sourcing at first mention. |
| docs/templates/stratara/public/main.css | Introduces styles for the new “basics” section on the landing page. |
| docs/overview/glossary.md | Adds CQRS/Event Sourcing entries and updates the Mediator definition to reference the pattern. |
| docs/index.md | Adds a short “thirty-second” explainer strip with links to the glossary and “Why event sourcing”. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
What this changes
The landing page, the README and the glossary all used "CQRS" without ever expanding it, and the glossary opened by saying it explains "common CQRS / Event-Sourcing terms" — which assumes the reader already has them. A developer who has not met the patterns has nowhere to land.
CQRSandEvent Sourcingas entries of their own, ahead of the terms that depend on them, andMediatornow names the pattern before naming our type.No deep treatment of the patterns — Fowler and Microsoft Learn own that ground, and a framework's docs competing there read as padding. This is the minimum needed for the page to make sense to someone meeting the words for the first time.
How it was verified
./scripts/local-gauntlet.sh)docfx build --warningsAsErrors— 0 warnings, 0 errors