TorbatYar/docs/README.md

TorbatYar Documentation

Permanent source of truth for architecture, standards, registries, deployment, and phase planning.

Start Here (every implementation phase)

1. project-status.yaml — first (execution dashboard; do not full-scan when present)
2. This file
3. ai-framework/ — permanent Enterprise / AI Development Framework (read before coding; ADR-013, ADR-018)
4. Active-service snapshot + latest handover only (via Project Index)
5. architecture/ and architecture/adr/ only if referenced
6. development/project-principles.md when required by stage
7. module-registry.md / glossary.md as cache-eligible ALWAYS READ
8. Relevant 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.md	Single execution dashboard — critical_path, execution_priority, deployment_readiness (read first)
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)
loyalty-phase-7-0.md	Loyalty Service Foundation (Phase 7.0)
communication-phase-8.md	Enterprise Communication Platform (Phase 8 — Production Ready SMS MVP)
communication-roadmap.md	Communication future channels & optional ops (roadmap only)
sports-center-roadmap.md	Sports Center Platform roadmap (Phases 9.0–9.10)
delivery-roadmap.md	Delivery & Fleet Platform roadmap (Phases 10.0–10.10)
delivery-phase-10-0.md	Delivery Platform Foundation (Phase 10.0)
experience-roadmap.md	Experience Platform roadmap (Phases 11.0–11.10)

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

AI / Enterprise Development Framework

Document	Responsibility
ai-framework/README.md	Framework purpose, usage, reading order
project-status.yaml	Single execution dashboard — critical_path / priorities / readiness
ai-framework/master-prompt.md	Global implementation rules
ai-framework/enterprise-phase-discovery.md	Mandatory pre-implementation discovery
ai-framework/definition-of-done.md	Mandatory Definition of Done
ai-framework/mandatory-phase-artifacts.md	Artifacts every phase includes by default
ai-framework/enterprise-completeness.md	Pre-close completeness verification
ai-framework/boundary-rules.md	Service/phase/integration hard boundaries
ai-framework/development-loop.md	Permanent implementation lifecycle
ai-framework/quality-gates.md	Mandatory quality gates
ai-framework/phase-manifest.yaml	Phase registry
ai-framework/service-manifest.yaml	Service registry
ai-framework/prompt-rules.md	Phase prompt rules
ai-framework/cursor-guidelines.md	Cursor workflow
architecture/adr/ADR-013.md	Framework ADR
architecture/adr/ADR-018.md	Enterprise Completeness Mandate
architecture/adr/ADR-019.md	Mandatory Enterprise Phase Discovery
architecture/adr/ADR-014.md	Sports Center Platform ADR
architecture/adr/ADR-015.md	Delivery & Fleet Platform ADR
architecture/adr/ADR-016.md	Experience Platform ADR

Decisions, Templates, Phases

Path	Responsibility
decisions/	Non-architectural decisions
templates/	Required document templates (short forms)
ai-framework/	AI implementation templates & lifecycle
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)
• Code completed for all in-scope business capabilities (CRUD is never sufficient)
• Mandatory phase artifacts delivered (ai-framework/mandatory-phase-artifacts.md)
• Definition of Done satisfied (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.md)
• Architecture validation passed
• Boundary rules respected (ai-framework/boundary-rules.md)
• Enterprise Completeness signed off (ai-framework/enterprise-completeness.md)
• AI/Enterprise framework quality gates passed (ai-framework/quality-gates.md)
• Phase handover completed (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
• current-architecture-review.md (historical review; superseded by this structure)