docs: add architecture guide, security model, and runbooks#48
Merged
MaryammAli merged 1 commit intoJun 22, 2026
Merged
Conversation
MaryammAli
approved these changes
Jun 22, 2026
MaryammAli
left a comment
Contributor
There was a problem hiding this comment.
LGTM
thanks for ur contribution
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.
📋 Summary
Add the missing backend documentation required by issue #24.
Type of Change
🎯 Requirements Checklist
Implementation
Security
Testing
📝 Detailed Changes
Added
ARCHITECTURE.md— module map, request lifecycle, cross-module contracts, data flowsRUNBOOK.md— env vars, migrations, observability stack, scheduled jobs, cache, incident checksUpdated
README.md— accurate platform overview, links to all canonical docsCONTRIBUTING.md— branching strategy, contributor checklist for multi-module changesSECURITY_CHECKLIST.md— fills in template placeholders, covers auth/authz/CORS/uploads/logging/JWTs/rate-limitingSECURITY_AUDIT_REPORT.md— resolved vs open findings, removes stale placeholderssrc/wallet/README.md— links canonical docs instead of duplicating guidancesrc/common/gateways/README.md— expanded with full event table and service usagesrc/analytics-system/README.md— links config and architecture docsscripts/README.md— links runbook for env setup🧪 Testing Instructions
Steps to Verify
npm run test— same 20 pre-existing failing suites, no regressions.npm run lint— same 1129 pre-existing problems, none introduced.🔗 Related Issues
Closes #24