feat: bmad documents #380
feat: bmad documents #380
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive BMAD (Brownfield Mapping and Documentation) documentation for the Blink Bitcoin banking platform. The documentation provides an exhaustive reference for understanding the system architecture, codebase organization, API contracts, data models, and development/operations workflows.
Key additions:
- Complete architectural documentation covering service components, authentication, payment processing, and deployment
- Detailed API contract documentation for GraphQL endpoints (public and admin)
- Comprehensive data model documentation for MongoDB and PostgreSQL schemas
- Source tree documentation explaining the monorepo structure and code organization
- DevOps documentation covering development environment, testing, CI/CD, and deployment
- AI agent guidelines to help code review tools understand the project structure
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs/bmad/index.md |
Master index providing project overview, technology stack summary, service map, and quick links to all documentation |
docs/bmad/architecture.md |
System architecture documentation covering service components, data flows, authentication, payment processing, security, and deployment patterns |
docs/bmad/api-contracts.md |
GraphQL API documentation including queries, mutations, subscriptions, authentication flows, and error handling |
docs/bmad/data-models.md |
Database schema documentation for MongoDB collections, PostgreSQL tables, and ledger system structure |
docs/bmad/source-tree.md |
Codebase organization guide showing repository structure, entry points, and domain-driven design layers |
docs/bmad/devops.md |
Development and operations guide covering local setup, testing, CI/CD pipeline, deployment, and troubleshooting |
docs/bmad/project-scan-report.json |
Metadata file tracking the documentation scan results, project types, and outputs generated |
AGENTS.md |
Guidelines for AI agents and code review tools explaining critical rules, code organization patterns, and quick reference commands |
.github/copilot-instructions.md |
GitHub Copilot configuration file directing the tool to follow AGENTS.md guidelines |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,3 @@ | |||
| # Blink Code Review Guidelines | |||
There was a problem hiding this comment.
The header uses "Github" but should be "GitHub" (with capital H) according to the official branding.
| │ Mobile App Dashboard Pay App Admin Panel Map Voucher │ | ||
| │ (External) (Next.js) (Next.js) (Next.js) (Next.js) (Next.js) |
There was a problem hiding this comment.
The ASCII diagram shows "Mobile App (External)" but there's no explicit documentation about this external mobile app in the service descriptions. Consider adding a note or reference about where the mobile app repository is located or clarifying that this is a separate project.
No description provided.