Home

Oscar Documentation

Welcome to the Oscar CRM wiki. This is the canonical index for all project documentation.

---

Getting Started

Document	Audience
Project Overview	Everyone
Quick Start Guide	Developers
Frontend README	Frontend developers

Technical Reference

Document	Contents
Architecture	Layered architecture, repository pattern, error conventions
API Reference	All REST endpoints by module
Database Schema	Key tables, RLS policies
CI/CD Strategy	Pipeline architecture, DORA metrics, deployment runbooks

Project Management

Document	PMBOK Reference
Project Charter	4.1 Develop Project Charter
Risk Register	11.2 Identify Risks
Phase 1 Retrospective	4.4 Monitor & Control
Project Board	4.3 Direct & Manage
Sprint Reports	10.1 Plan Communications

Community & Governance

Document	Location (main repo)
Contributing Guide	Root
Code of Conduct	Root
Security Policy	Root
Pull Request Template	.github/
Issue Templates	.github/ISSUE_TEMPLATE/

Issue Types

Template	When to Use
User Story	Feature from end-user perspective with WSJF
Task	Technical or process work
Spike	Research, exploration, proof-of-concept
Epic	Large body spanning multiple issues
Bug Report	Something isn't working
Feature Request	Idea or enhancement

Document Map

.github/                         # Governance (PM artifacts, templates)
  ├── PROJECT_CHARTER.md         # Project charter (PMBOK 4.1)
  ├── RISK_REGISTER.md           # Risk register (PMBOK 11.2)
  ├── RETROSPECTIVE_PHASE1.md    # Phase 1 retrospective
  ├── PULL_REQUEST_TEMPLATE.md   # PR template
  └── ISSUE_TEMPLATE/            # Issue templates (6)

docs/                            # Technical documentation
  ├── README.md                  # Documentation index (source of this wiki)
  └── CI-CD.md                   # CI/CD strategy + runbooks

web/README.md                    # Frontend docs

README.md                        # Project landing page
CONTRIBUTING.md                  # Contribution guide
CODE_OF_CONDUCT.md               # Code of conduct
SECURITY.md                      # Security policy

---

This wiki is maintained at docs/README.md in the main repository and synced via .github/workflows/sync-wiki.yml.