SyRF Repo Documentation¶
Welcome to the SyRF (Systematic Review Facility) documentation. This comprehensive guide covers architecture, development, deployment, and operational aspects of the SyRF platform.
Multi-Repository Documentation: This site aggregates documentation from:
- SyRF Monorepo - Application code and architecture
- Cluster GitOps - Deployment and operations
- Infrastructure - Terraform and cluster configuration
Quick Start¶
- New to SyRF? Start with the System Overview
- Setting up development? Development setup guide (coming soon)
- Looking for API docs? API reference documentation (coming soon)
- Working with CI/CD? See CI/CD Workflow
- Contributing? Read our Documentation Framework (see repository root)
Documentation Structure¶
📐 Architecture¶
System design, technical architecture, and dependency maps.
📋 Decisions¶
Architecture Decision Records (ADRs) documenting key technical choices.
🚀 Features¶
Feature briefs and technical plans for system capabilities.
📖 How-To Guides¶
Step-by-step instructions for common development and operational tasks.
📝 Planning¶
Active planning documents and discussions (temporary).
Key Resources¶
| Resource | Description |
|---|---|
| Dependency Map | Service and library dependencies |
| CI/CD Pipeline | Build and deployment strategy |
| GitOps Setup | Kubernetes and ArgoCD configuration |
| Documentation Guide | How to write and maintain docs (see /docs/README.md in repo) |
Technology Stack¶
- Backend: .NET 8.0, MongoDB, MassTransit
- Frontend: Angular
- Infrastructure: Docker, Kubernetes, Helm
- CI/CD: GitHub Actions, GitVersion, ArgoCD
- Registry: GitHub Container Registry (GHCR)
Services¶
| Service | Purpose | Port | Type |
|---|---|---|---|
| API | Main REST API | 8080 | REST |
| Project Management | DDD-based PM service | 8081 | REST |
| Quartz | Background job scheduler | 8082 | Worker |
| Web | Angular frontend | 80 | SPA |
| S3 Notifier | AWS Lambda for S3 events | N/A | Lambda |
Getting Help¶
- Documentation Issues: Create an issue in GitHub
- Questions: Check Planning for discussions
- Contributing: Follow our Documentation Framework (see /docs/README.md in repo)
Recent Updates¶
- 2025-11-13: Fixed ArgoCD version tracking with service-per-file configuration structure
- 2025-11-13: Automated staging with auto-merge + manual production promotion workflow
- 2025-11-12: Fixed MkDocs navigation and README.md conflicts
- 2025-11-04: Migrated to new documentation framework
- 2024-11-03: Completed GitOps repository setup
- 2024-11-02: Implemented CI/CD pipeline with auto-versioning