morteza/TorbatYar
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
ea5fabaa7c
TorbatYar/docs/README.md
Mortezakoohjani 091b33a638 feat(platform): finalize commercial runtime, platform shell and hospitality production frontend 
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-28 20:39:10 +03:30

179 lines
10 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# TorbatYar Documentation
Permanent source of truth for architecture, standards, registries, deployment, and phase planning.
## Start Here (every implementation phase)
1. [`project-status.yaml`](project-status.yaml) — **first** (execution dashboard; do not full-scan when present)
2. This file
3. [ai-framework/](ai-framework/) — permanent Enterprise / AI Development Framework (read before coding; [ADR-013](architecture/adr/ADR-013.md), [ADR-018](architecture/adr/ADR-018.md))
4. Active-service snapshot + latest handover only (via Project Index)
5. [architecture/](architecture/) and [architecture/adr/](architecture/adr/) **only if referenced**
6. [development/project-principles.md](development/project-principles.md) when required by stage
7. [module-registry.md](module-registry.md) / [glossary.md](glossary.md) as cache-eligible ALWAYS READ
8. Relevant [phases/](phases/) docs for the **current phase only**
If a change affects architecture, APIs, providers, or module boundaries: **update documentation first**, then code.
## Navigation
### Status & Planning
| Document | Responsibility |
| --- | --- |
| [project-status.yaml](project-status.yaml) / [project-status.md](project-status.md) | **Single execution dashboard** — critical_path, execution_priority, deployment_readiness (read first) |
| [progress.md](progress.md) | Completed work only |
| [roadmap.md](roadmap.md) | Future roadmap only |
| [next-steps.md](next-steps.md) | Immediate next milestone only |
| [crm-phase-6-0.md](crm-phase-6-0.md) | CRM Service Foundation (Phase 6.0) |
| [crm-phase-6-1.md](crm-phase-6-1.md) | CRM Core Business Entities (Phase 6.1) |
| [crm-phase-6-2.md](crm-phase-6-2.md) | CRM Enterprise Sales Process Engine (Phase 6.2) |
| [crm-phase-6-3.md](crm-phase-6-3.md) | CRM Enterprise Sales Collaboration (Phase 6.3) |
| [loyalty-phase-7-0.md](loyalty-phase-7-0.md) | Loyalty Service Foundation (Phase 7.0) |
| [communication-phase-8.md](communication-phase-8.md) | Enterprise Communication Platform (Phase 8 — Production Ready SMS MVP) |
| [communication-roadmap.md](communication-roadmap.md) | Communication future channels & optional ops (roadmap only) |
| [sports-center-roadmap.md](sports-center-roadmap.md) | Sports Center Platform roadmap (Phases 9.0–9.10) |
| [delivery-roadmap.md](delivery-roadmap.md) | Delivery & Fleet Platform roadmap (Phases 10.0–10.10) |
| [delivery-phase-10-0.md](delivery-phase-10-0.md) | Delivery Platform Foundation (Phase 10.0) |
| [experience-roadmap.md](experience-roadmap.md) | Experience Platform roadmap (Phases 11.0–11.10) |
### Architecture
| Document | Responsibility |
| --- | --- |
| [architecture/architecture.md](architecture/architecture.md) | Overview |
| [architecture/module-boundaries.md](architecture/module-boundaries.md) | Ownership boundaries |
| [architecture/database-architecture.md](architecture/database-architecture.md) | DB architecture |
| [architecture/multi-tenant-architecture.md](architecture/multi-tenant-architecture.md) | Tenancy |
| [architecture/deployment-architecture.md](architecture/deployment-architecture.md) | Runtime topology |
| [architecture/security-architecture.md](architecture/security-architecture.md) | Security |
| [architecture/identity-architecture.md](architecture/identity-architecture.md) | Identity |
| [architecture/authorization-architecture.md](architecture/authorization-architecture.md) | Authz |
| [architecture/integration-architecture.md](architecture/integration-architecture.md) | Integrations |
| [architecture/event-driven-architecture.md](architecture/event-driven-architecture.md) | Events |
| [architecture/service-architecture.md](architecture/service-architecture.md) | Service layering |
| [architecture/ai-architecture.md](architecture/ai-architecture.md) | AI rules |
| [architecture/compliance-architecture.md](architecture/compliance-architecture.md) | Compliance |
| [architecture/adr/](architecture/adr/) | ADRs (one decision per file) |
### Development
| Document | Responsibility |
| --- | --- |
| [development/developer-guide.md](development/developer-guide.md) | How to run/develop |
| [development/project-principles.md](development/project-principles.md) | Mandatory principles |
| [development/coding-standards.md](development/coding-standards.md) | Coding conventions |
| [development/testing-strategy.md](development/testing-strategy.md) | Testing |
| [development/branching-strategy.md](development/branching-strategy.md) | Git branches |
| [development/release-strategy.md](development/release-strategy.md) | Releases |
### Reference
| Document | Responsibility |
| --- | --- |
| [reference/database-schema.md](reference/database-schema.md) | Schema reference |
| [reference/services-contracts.md](reference/services-contracts.md) | Service contracts |
| [reference/api-reference.md](reference/api-reference.md) | API index |
| [reference/event-catalog.md](reference/event-catalog.md) | Events |
| [reference/provider-reference.md](reference/provider-reference.md) | Provider details |
### Deployment
| Document | Responsibility |
| --- | --- |
| [deployment/deployment.md](deployment/deployment.md) | Deploy overview |
| [deployment/production.md](deployment/production.md) | Production |
| [deployment/ssl.md](deployment/ssl.md) | TLS / tenant SSL |
| [deployment/monitoring.md](deployment/monitoring.md) | Monitoring |
| [deployment/backup.md](deployment/backup.md) | Backup |
| [deployment/restore.md](deployment/restore.md) | Restore |
| [deployment/disaster-recovery.md](deployment/disaster-recovery.md) | DR |
### Registries & Glossary
| Document | Responsibility |
| --- | --- |
| [module-registry.md](module-registry.md) | All modules |
| [provider-registry.md](provider-registry.md) | All providers |
| [glossary.md](glossary.md) | Terms |
### Frontend
| Document | Responsibility |
| --- | --- |
| [frontend/README.md](frontend/README.md) | Accounting UI & design system index |
### AI / Enterprise Development Framework
| Document | Responsibility |
| --- | --- |
| [ai-framework/README.md](ai-framework/README.md) | Framework purpose, usage, reading order |
| [project-status.yaml](project-status.yaml) | Single execution dashboard — critical_path / priorities / readiness |
| [ai-framework/master-prompt.md](ai-framework/master-prompt.md) | Global implementation rules |
| [ai-framework/enterprise-phase-discovery.md](ai-framework/enterprise-phase-discovery.md) | Mandatory pre-implementation discovery |
| [ai-framework/definition-of-done.md](ai-framework/definition-of-done.md) | Mandatory Definition of Done |
| [ai-framework/mandatory-phase-artifacts.md](ai-framework/mandatory-phase-artifacts.md) | Artifacts every phase includes by default |
| [ai-framework/enterprise-completeness.md](ai-framework/enterprise-completeness.md) | Pre-close completeness verification |
| [ai-framework/boundary-rules.md](ai-framework/boundary-rules.md) | Service/phase/integration hard boundaries |
| [ai-framework/development-loop.md](ai-framework/development-loop.md) | Permanent implementation lifecycle |
| [ai-framework/quality-gates.md](ai-framework/quality-gates.md) | Mandatory quality gates |
| [ai-framework/phase-manifest.yaml](ai-framework/phase-manifest.yaml) | Phase registry |
| [ai-framework/service-manifest.yaml](ai-framework/service-manifest.yaml) | Service registry |
| [ai-framework/prompt-rules.md](ai-framework/prompt-rules.md) | Phase prompt rules |
| [ai-framework/cursor-guidelines.md](ai-framework/cursor-guidelines.md) | Cursor workflow |
| [architecture/adr/ADR-013.md](architecture/adr/ADR-013.md) | Framework ADR |
| [architecture/adr/ADR-018.md](architecture/adr/ADR-018.md) | Enterprise Completeness Mandate |
| [architecture/adr/ADR-019.md](architecture/adr/ADR-019.md) | Mandatory Enterprise Phase Discovery |
| [architecture/adr/ADR-014.md](architecture/adr/ADR-014.md) | Sports Center Platform ADR |
| [architecture/adr/ADR-015.md](architecture/adr/ADR-015.md) | Delivery & Fleet Platform ADR |
| [architecture/adr/ADR-016.md](architecture/adr/ADR-016.md) | Experience Platform ADR |
### Decisions, Templates, Phases
| Path | Responsibility |
| --- | --- |
| [decisions/](decisions/) | Non-architectural decisions |
| [templates/](templates/) | Required document templates (short forms) |
| [ai-framework/](ai-framework/) | AI implementation templates & lifecycle |
| [phases/](phases/) | Phase area documentation |
## Phase Completion Gate
No implementation phase is complete until:
- [ ] Business Analysis completed for the phase
- [ ] Enterprise Phase Discovery completed; Missing→Implement gaps closed ([ai-framework/enterprise-phase-discovery.md](ai-framework/enterprise-phase-discovery.md))
- [ ] Code completed for **all** in-scope business capabilities (CRUD is never sufficient)
- [ ] Mandatory phase artifacts delivered ([ai-framework/mandatory-phase-artifacts.md](ai-framework/mandatory-phase-artifacts.md))
- [ ] Definition of Done satisfied ([ai-framework/definition-of-done.md](ai-framework/definition-of-done.md))
- [ ] Tests passed
- [ ] Documentation updated
- [ ] ADR updated (if required)
- [ ] Module Registry updated
- [ ] Provider Registry updated (if required)
- [ ] Progress updated
- [ ] Next Steps updated
- [ ] Project Status updated ([project-status.yaml](project-status.yaml) + [project-status.md](project-status.md))
- [ ] Architecture validation passed
- [ ] Boundary rules respected ([ai-framework/boundary-rules.md](ai-framework/boundary-rules.md))
- [ ] Enterprise Completeness signed off ([ai-framework/enterprise-completeness.md](ai-framework/enterprise-completeness.md))
- [ ] AI/Enterprise framework quality gates passed ([ai-framework/quality-gates.md](ai-framework/quality-gates.md))
- [ ] Phase handover completed ([ai-framework/phase-handover.md](ai-framework/phase-handover.md))
- [ ] Manifests updated (if phase/service registration changed)
- [ ] 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, testing strategy, and the Enterprise / AI Development Framework. 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](../README.md)
- [current-architecture-review.md](current-architecture-review.md) (historical review; superseded by this structure)
Reference in New Issue View Git Blame Copy Permalink