Skip to content

docs: add architecture guide, security model, and runbooks#48

Merged
MaryammAli merged 1 commit into
Proof-Stell:mainfrom
portableDD:feat/portableDD-docs-arch-security-ops
Jun 22, 2026
Merged

docs: add architecture guide, security model, and runbooks#48
MaryammAli merged 1 commit into
Proof-Stell:mainfrom
portableDD:feat/portableDD-docs-arch-security-ops

Conversation

@portableDD

Copy link
Copy Markdown
Contributor

📋 Summary

Add the missing backend documentation required by issue #24.

Type of Change

  • Documentation Update

🎯 Requirements Checklist

Implementation

  • Feature requirements have been fully implemented
  • Code follows project architecture and conventions

Security

  • No secrets, credentials, or environment-specific values are included

Testing

  • Existing tests pass successfully

📝 Detailed Changes

Added

  • ARCHITECTURE.md — module map, request lifecycle, cross-module contracts, data flows
  • RUNBOOK.md — env vars, migrations, observability stack, scheduled jobs, cache, incident checks

Updated

  • README.md — accurate platform overview, links to all canonical docs
  • CONTRIBUTING.md — branching strategy, contributor checklist for multi-module changes
  • SECURITY_CHECKLIST.md — fills in template placeholders, covers auth/authz/CORS/uploads/logging/JWTs/rate-limiting
  • SECURITY_AUDIT_REPORT.md — resolved vs open findings, removes stale placeholders
  • src/wallet/README.md — links canonical docs instead of duplicating guidance
  • src/common/gateways/README.md — expanded with full event table and service usage
  • src/analytics-system/README.md — links config and architecture docs
  • scripts/README.md — links runbook for env setup

🧪 Testing Instructions

Steps to Verify

  1. All linked documents render correctly on GitHub.
  2. npm run test — same 20 pre-existing failing suites, no regressions.
  3. npm run lint — same 1129 pre-existing problems, none introduced.

🔗 Related Issues

Closes #24

@MaryammAli MaryammAli 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.

LGTM
thanks for ur contribution

@MaryammAli
MaryammAli merged commit 1c27d35 into Proof-Stell:main Jun 22, 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.

Document backend architecture, security model, and operational runbooks

2 participants