Skip to content

docs: create architecture decision records (ADRs) - #236

Merged
Xhristin3 merged 1 commit into
XStreamRollz:mainfrom
Agbasimere:issues/232
Jun 16, 2026
Merged

docs: create architecture decision records (ADRs)#236
Xhristin3 merged 1 commit into
XStreamRollz:mainfrom
Agbasimere:issues/232

Conversation

@Agbasimere

Copy link
Copy Markdown
Contributor

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/:

  1. 0001-use-nestjs.md: Adoption of NestJS backend framework.
  2. 0002-in-memory-first.md: Details the in-memory-first repository pattern.
  3. 0003-polling-based-processing.md: Details the polling-based daemon worker processing model.
  4. 0004-raw-sql-over-orm.md: Explains using raw SQL queries with pg instead of ORMs.
  5. 0005-socket-io-realtime.md: Documents using Socket.IO for real-time events and room management.
  6. 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.

@Xhristin3 Xhristin3 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@Xhristin3
Xhristin3 merged commit 3f1045e into XStreamRollz:main Jun 16, 2026
1 check passed
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.

docs: Create Architecture Decision Records (ADRs)

2 participants