docs/agent/README.md
Complete reference for AI agents working with Resume Matcher.
Start with the topics below.
| Doc | Purpose |
|---|---|
| scope-and-principles | Rules, what's in/out of scope |
| quickstart | Install, run, test commands |
| workflow | Git, PRs, testing |
| coding-standards | Frontend/backend conventions |
| Doc | Purpose |
|---|---|
| backend-architecture | Backend modules, API, services |
| frontend-architecture | Components, pages, state |
| Doc | Purpose |
|---|---|
| front-end-apis | API contract |
| api-flow-maps | Request/response flows |
| Doc | Purpose |
|---|---|
| style-guide | Swiss International Style |
| template-system | Resume templates |
| pdf-template-guide | PDF rendering |
| Doc | Purpose |
|---|---|
| custom-sections | Dynamic sections |
| i18n | Internationalization |
| Doc | Purpose |
|---|---|
| llm-integration | Multi-provider AI |
apps/
├── backend/ # FastAPI + Python
│ ├── app/
│ │ ├── main.py # Entry point
│ │ ├── routers/ # API endpoints
│ │ ├── services/ # Business logic
│ │ └── prompts/ # LLM templates
│ └── data/ # Database storage
│
└── frontend/ # Next.js + React
├── app/ # Pages
├── components/ # UI components
└── lib/ # Utilities, API client
New tasks: Read scope-and-principles → quickstart → workflow
Backend changes: backend-architecture → front-end-apis → llm-integration
Frontend changes: frontend-architecture → style-guide → coding-standards
Template/PDF changes: pdf-template-guide → template-system