wehub-resource-sync
94 lines
4.4 KiB
Markdown
94 lines
4.4 KiB
Markdown
# Resume Matcher — Agent Documentation Index
|
|
|
|
> Project-specific reference for agents working in the Resume Matcher codebase.
|
|
|
|
Generic, reusable guides (Swiss design system, Next.js performance) live in [`../portable/`](../portable/README.md) 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.
|
|
|
|
## Quick Navigation
|
|
|
|
### Core docs
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [scope-and-principles](scope-and-principles.md) | Rules, what's in/out of scope |
|
|
| [quickstart](quickstart.md) | Install, run, test commands |
|
|
| [workflow](workflow.md) | Git, PRs, testing |
|
|
| [coding-standards](coding-standards.md) | Frontend/backend conventions |
|
|
|
|
### Architecture
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [backend-architecture](architecture/backend-architecture.md) | Backend modules, API, services |
|
|
| [backend-guide](architecture/backend-guide.md) | Module-by-module backend tour |
|
|
| [frontend-architecture](architecture/frontend-architecture.md) | Components, pages, state |
|
|
| [frontend-workflow](architecture/frontend-workflow.md) | User flows in the frontend |
|
|
| [prompt-workflow-design](architecture/prompt-workflow-design.md) | Improver pipeline design (superseded — historical) |
|
|
|
|
### APIs
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [front-end-apis](apis/front-end-apis.md) | API contract |
|
|
| [api-flow-maps](apis/api-flow-maps.md) | Request/response flows |
|
|
| [backend-requirements](apis/backend-requirements.md) | Backend behavioral requirements |
|
|
|
|
### Design (Resume Matcher specifics)
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [template-system](design/template-system.md) | Resume template architecture |
|
|
| [pdf-template-guide](design/pdf-template-guide.md) | PDF rendering pipeline |
|
|
| [print-pdf-design-spec](design/print-pdf-design-spec.md) | Print/PDF design spec |
|
|
| [resume-template-design-spec](design/resume-template-design-spec.md) | Resume template design spec |
|
|
| [templates/swiss-single-spec](design/templates/swiss-single-spec.md) | Single-column Swiss template spec |
|
|
| [templates/swiss-two-column-spec](design/templates/swiss-two-column-spec.md) | Two-column Swiss template spec |
|
|
|
|
> **For the design system itself** (colors, components, anti-patterns), see the portable pack: [`../portable/swiss-design-system/`](../portable/swiss-design-system/README.md)
|
|
|
|
### Features
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [custom-sections](features/custom-sections.md) | Dynamic sections |
|
|
| [resume-templates](features/resume-templates.md) | Template types and controls |
|
|
| [adding-resume-templates](features/adding-resume-templates.md) | How to add a new template |
|
|
| [enrichment](features/enrichment.md) | AI enrichment flow |
|
|
| [jd-match](features/jd-match.md) | Job description matching |
|
|
| [i18n](features/i18n.md) | Internationalization |
|
|
| [i18n-preparation](features/i18n-preparation.md) | i18n setup notes |
|
|
|
|
### LLM Integration
|
|
| Doc | Purpose |
|
|
|-----|---------|
|
|
| [llm-integration](llm-integration.md) | Multi-provider AI via LiteLLM |
|
|
|
|
### Portable packs (live outside this folder)
|
|
| Pack | Purpose |
|
|
|------|---------|
|
|
| [swiss-design-system](../portable/swiss-design-system/README.md) | Full Swiss style design system — required reading for frontend work |
|
|
| [nextjs-performance](../portable/nextjs-performance/README.md) | 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/swiss-design-system/README.md) → portable [`nextjs-performance`](../portable/nextjs-performance/README.md) → `coding-standards`
|
|
|
|
**Template/PDF changes:** `pdf-template-guide` → `template-system`
|