docs: create architecture decision records (ADRs) - #236
Merged
Conversation
Xhristin3
approved these changes
Jun 16, 2026
Xhristin3
left a comment
Contributor
There was a problem hiding this comment.
Hey @Agbasimere! These ADRs are excellent - the context-decision-consequences format is spot on and you covered the key architectural choices (NestJS, in-memory-first, polling, raw SQL, Socket.IO, workspaces) really well. Each record clearly explains the why, not just the what. Great documentation work!
3 tasks
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.
Description
This PR introduces the initial set of Architecture Decision Records (ADRs) for the XStreamRoll codebase. These records document critical design decisions to establish technical context, onboard new team members, and prevent regression or accidental refactoring of intentional patterns.
The new ADRs are located under
docs/adr/:0001-use-nestjs.md: Adoption of NestJS backend framework.0002-in-memory-first.md: Details the in-memory-first repository pattern.0003-polling-based-processing.md: Details the polling-based daemon worker processing model.0004-raw-sql-over-orm.md: Explains using raw SQL queries withpginstead of ORMs.0005-socket-io-realtime.md: Documents using Socket.IO for real-time events and room management.0006-npm-workspaces.md: Explains the npm workspaces monorepo structure.Related Issue
Fixes #232
How to Verify
Verify that all markdown files exist in
docs/adr/, read correctly, and conform to standard ADR formats (Title, Status, Context, Decision, Consequences). All files have been successfully validated and formatted with Prettier.