TorbatYar/docs/README.md

# TorbatYar Documentation

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

## Start Here (every implementation phase)

1. This file
2. [architecture/](architecture/) and [architecture/adr/](architecture/adr/)
3. [development/project-principles.md](development/project-principles.md)
4. [development/coding-standards.md](development/coding-standards.md)
5. [development/testing-strategy.md](development/testing-strategy.md)
6. [module-registry.md](module-registry.md)
7. [provider-registry.md](provider-registry.md)
8. [glossary.md](glossary.md)
9. Relevant [phases/](phases/) docs

If a change affects architecture, APIs, providers, or module boundaries: **update documentation first**, then code.

## Navigation

### Status & Planning

| Document | Responsibility |
| --- | --- |
| [progress.md](progress.md) | Completed work only |
| [roadmap.md](roadmap.md) | Future roadmap only |
| [next-steps.md](next-steps.md) | Immediate next milestone only |

### 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 |

### Decisions, Templates, Phases

| Path | Responsibility |
| --- | --- |
| [decisions/](decisions/) | Non-architectural decisions |
| [templates/](templates/) | Required document templates |
| [phases/](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](../README.md)
- [current-architecture-review.md](current-architecture-review.md) (historical review; superseded by this structure)