Home

Oscar Documentation

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

---

Getting Started

Document	Location	Audience
Project Overview	Root README	Everyone
Quick Start Guide	Root README	Developers
Frontend README	web/README.md	Frontend developers

Technical Reference

Document	Location	Contents
Architecture	Root README	Layered architecture, repository pattern, error conventions
API Reference	Root README	All REST endpoints by module
Database Schema	Root README	Key tables, RLS policies
CI/CD Pipeline	docs/CI-CD.md	Pipeline architecture, DORA metrics, deployment runbooks

Project Management

Document	Location	PMBOK Reference
Project Charter	.github/PROJECT_CHARTER.md	4.1 Develop Project Charter
Risk Register	.github/RISK_REGISTER.md	11.2 Identify Risks
Phase 1 Retrospective	.github/RETROSPECTIVE_PHASE1.md	4.4 Monitor & Control
Project Board	GitHub Projects V2	4.3 Direct & Manage
Sprint Reports	GitHub Discussions	10.1 Plan Communications

Community & Governance

Document	Location
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

GitHub Wiki

Note: The GitHub Wiki requires a one-time initialization. Visit https://github.com/CaptDany/oscar/wiki in your browser to create it. After that, wiki content can be pushed via git or the GitHub Wiki API. The following pages are staged for the wiki:

• Home — Overview and quick links (this document)
• Project Charter — Vision, scope, risks, MVP
• Risk Register — Probability/Impact risk matrix
• API Reference — All REST endpoints

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                    # ← You are here
└── 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 documentation structure follows the Lean "see the whole" principle — all project knowledge in one navigable index.