Generic, reusable guides (Swiss design system, Next.js performance) live in ../portable/ as standalone packs that can be lifted out of this repo and dropped into any project. This index covers only the docs that are tied to Resume Matcher itself.

Core docs

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

Architecture

Doc	Purpose
backend-architecture	Backend modules, API, services
backend-guide	Module-by-module backend tour
frontend-architecture	Components, pages, state
frontend-workflow	User flows in the frontend
prompt-workflow-design	Improver pipeline design (superseded — historical)

APIs

Doc	Purpose
front-end-apis	API contract
api-flow-maps	Request/response flows
backend-requirements	Backend behavioral requirements

Design (Resume Matcher specifics)

Doc	Purpose
template-system	Resume template architecture
pdf-template-guide	PDF rendering pipeline
print-pdf-design-spec	Print/PDF design spec
resume-template-design-spec	Resume template design spec
templates/swiss-single-spec	Single-column Swiss template spec
templates/swiss-two-column-spec	Two-column Swiss template spec

For the design system itself (colors, components, anti-patterns), see the portable pack: ../portable/swiss-design-system/

Features

Doc	Purpose
custom-sections	Dynamic sections
resume-templates	Template types and controls
adding-resume-templates	How to add a new template
enrichment	AI enrichment flow
jd-match	Job description matching
i18n	Internationalization
i18n-preparation	i18n setup notes

LLM Integration

Doc	Purpose
llm-integration	Multi-provider AI via LiteLLM

Portable packs (live outside this folder)

Pack	Purpose
swiss-design-system	Full Swiss style design system — required reading for frontend work
nextjs-performance	Next.js 15 performance optimizations — required reading for frontend work

Project Structure

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

How to Use

New tasks: Read scope-and-principles → quickstart → workflow

Backend changes: backend-architecture → front-end-apis → llm-integration

Frontend changes: frontend-architecture → portable swiss-design-system → portable nextjs-performance → coding-standards

Template/PDF changes: pdf-template-guide → template-system

README.md

Resume Matcher — Agent Documentation Index

Quick Navigation