Document successful CRM 6.3 prod smoke checks and retry CRM /health during deploy. Co-authored-by: Cursor <cursoragent@cursor.com> |
||
|---|---|---|
| .. | ||
| architecture | ||
| decisions | ||
| deployment | ||
| development | ||
| frontend | ||
| phases | ||
| reference | ||
| templates | ||
| architecture.md | ||
| crm-phase-6-0.md | ||
| crm-phase-6-1.md | ||
| crm-phase-6-2.md | ||
| crm-phase-6-3.md | ||
| current-architecture-review.md | ||
| database_schema.md | ||
| developer_guide.md | ||
| glossary.md | ||
| last_step.md | ||
| module-registry.md | ||
| next-steps.md | ||
| progress.md | ||
| provider-registry.md | ||
| README.md | ||
| roadmap.md | ||
| services_contracts.md | ||
TorbatYar Documentation
Permanent source of truth for architecture, standards, registries, deployment, and phase planning.
Start Here (every implementation phase)
- This file
- architecture/ and architecture/adr/
- development/project-principles.md
- development/coding-standards.md
- development/testing-strategy.md
- module-registry.md
- provider-registry.md
- glossary.md
- Relevant phases/ docs
If a change affects architecture, APIs, providers, or module boundaries: update documentation first, then code.
Navigation
Status & Planning
| Document | Responsibility |
|---|---|
| progress.md | Completed work only |
| roadmap.md | Future roadmap only |
| next-steps.md | Immediate next milestone only |
| crm-phase-6-0.md | CRM Service Foundation (Phase 6.0) |
| crm-phase-6-1.md | CRM Core Business Entities (Phase 6.1) |
| crm-phase-6-2.md | CRM Enterprise Sales Process Engine (Phase 6.2) |
| crm-phase-6-3.md | CRM Enterprise Sales Collaboration (Phase 6.3) |
Architecture
| Document | Responsibility |
|---|---|
| architecture/architecture.md | Overview |
| architecture/module-boundaries.md | Ownership boundaries |
| architecture/database-architecture.md | DB architecture |
| architecture/multi-tenant-architecture.md | Tenancy |
| architecture/deployment-architecture.md | Runtime topology |
| architecture/security-architecture.md | Security |
| architecture/identity-architecture.md | Identity |
| architecture/authorization-architecture.md | Authz |
| architecture/integration-architecture.md | Integrations |
| architecture/event-driven-architecture.md | Events |
| architecture/service-architecture.md | Service layering |
| architecture/ai-architecture.md | AI rules |
| architecture/compliance-architecture.md | Compliance |
| architecture/adr/ | ADRs (one decision per file) |
Development
| Document | Responsibility |
|---|---|
| development/developer-guide.md | How to run/develop |
| development/project-principles.md | Mandatory principles |
| development/coding-standards.md | Coding conventions |
| development/testing-strategy.md | Testing |
| development/branching-strategy.md | Git branches |
| development/release-strategy.md | Releases |
Reference
| Document | Responsibility |
|---|---|
| reference/database-schema.md | Schema reference |
| reference/services-contracts.md | Service contracts |
| reference/api-reference.md | API index |
| reference/event-catalog.md | Events |
| reference/provider-reference.md | Provider details |
Deployment
| Document | Responsibility |
|---|---|
| deployment/deployment.md | Deploy overview |
| deployment/production.md | Production |
| deployment/ssl.md | TLS / tenant SSL |
| deployment/monitoring.md | Monitoring |
| deployment/backup.md | Backup |
| deployment/restore.md | Restore |
| deployment/disaster-recovery.md | DR |
Registries & Glossary
| Document | Responsibility |
|---|---|
| module-registry.md | All modules |
| provider-registry.md | All providers |
| glossary.md | Terms |
Frontend
| Document | Responsibility |
|---|---|
| frontend/README.md | Accounting UI & design system index |
Decisions, Templates, Phases
| Path | Responsibility |
|---|---|
| decisions/ | Non-architectural decisions |
| templates/ | Required document templates |
| phases/ | Phase area documentation |
Phase Completion Gate
No implementation phase is complete until:
- Code completed
- Tests passed
- Documentation updated
- ADR updated (if required)
- Module Registry updated
- Provider Registry updated (if required)
- Progress updated
- Next Steps updated
- Architecture validation passed
- No TODO remains
- Self review completed
- Final verification completed
Architecture Guard
Before modifying application code, verify consistency with principles, ADRs, registries, tenancy, database architecture, coding standards, and testing strategy. On conflict: stop, explain, correct docs/ADR first.
Deprecated Paths
Older paths may remain as stubs pointing here. Do not add new content to deprecated files.
Related
- Root README.md
- current-architecture-review.md (historical review; superseded by this structure)