chore(docs): document projection runtime boundary#416
Conversation
yordis
commented
Jul 1, 2026
- Keep the database-node boundary explicit before future feature work expands in-node projection responsibilities.
- Make projection runtime expansion external by default while preserving optional system projections for compatibility.
- Keep multi-stream append framed as a core write-semantics decision rather than incidental projection plumbing.
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
PR SummaryLow Risk Overview The new page states that the core node owns the durable event log (append/read, replication, storage, auth, etc.) and that user-defined projection runtimes, rich read models, and custom query surfaces are external components by default. System projections stay optional for compatibility but should not expand into a general in-node platform. Multi-stream append is framed as a core write-semantics decision, not projection plumbing.
Reviewed by Cursor Bugbot for commit 7a7c0f5. Bugbot is set up for automated code reviews on this repo. Configure here. |
WalkthroughThis PR adds a new architecture.md document describing the boundary between core event-store node responsibilities and external projection/query components, links it from README and sidebar navigation, and updates projections.md with corresponding guidance. ChangesArchitecture direction documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/architecture.md`:
- Around line 7-9: The architecture doc uses the internal name TrogonEventStore,
which is inconsistent with the public product name used elsewhere. Update the
wording in this section to use EventStoreDB consistently, and check nearby
documentation for any other occurrences of TrogonEventStore so the naming
matches the established docs.
In `@docs/projections.md`:
- Around line 38-43: The documentation text uses TrogonEventStore instead of the
established product name EventStoreDB, creating a naming inconsistency. Update
the prose in this projections section to use EventStoreDB consistently, matching
the terminology used across the rest of the docs and the referenced architecture
material.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 319bf0c0-2105-4f36-8256-4adfaa31782e
📒 Files selected for processing (4)
docs/README.mddocs/architecture.mddocs/projections.mddocs/sidebar.js