Skip to content

docs: full audit — align all docs with current code + production depl… - #1

Merged
4reeb-5yed merged 1 commit into
mainfrom
feature/analysis-quality-ux
Jun 26, 2026
Merged

4reeb-5yed merged 1 commit into
mainfrom
feature/analysis-quality-ux

Conversation

@4reeb-5yed

Copy link
Copy Markdown
Owner

…oyment

  • README: complete rewrite (overview, features, mermaid architecture, screenshots placeholder, tech stack, structure, local setup, env var tables, running, migrations, deployment, API overview, roadmap, license, badges, live URLs)
  • DEPLOYMENT: rewrite for actual Vercel + Render + Neon; build/start commands, env vars, CORS, async DATABASE_URL, and the required one-time 'alembic upgrade head' (documents the 'relation does not exist' issue); production notes
  • server/README: FastAPI, Alembic, Postgres, analysis pipeline, resume upload, job scraper, background tasks (submit->poll), config, layout
  • client/README: React, Vite, routing, API communication, build, Vercel deploy
  • CONTRIBUTING: drop obsolete Phase-1-only scope/task-ID framing; keep arch constraints + workflow; reflect current features and CI
  • SETUP_GUIDE: fix stale notes (fail-fast on missing key, setup.sh does not run migrations), add CAREER_AGENT_MODEL + provider note + cache TTL, update verify steps
  • API_CONTRACTS + DATABASE: jobId optional, new result shape (mode/careerReport/ jobMatch), analyses.job_id nullable + career_report column + migration 0002
  • ci.yml comment de-references old phase plan; add MIT LICENSE

…oyment

- README: complete rewrite (overview, features, mermaid architecture, screenshots
  placeholder, tech stack, structure, local setup, env var tables, running,
  migrations, deployment, API overview, roadmap, license, badges, live URLs)
- DEPLOYMENT: rewrite for actual Vercel + Render + Neon; build/start commands,
  env vars, CORS, async DATABASE_URL, and the required one-time 'alembic upgrade
  head' (documents the 'relation does not exist' issue); production notes
- server/README: FastAPI, Alembic, Postgres, analysis pipeline, resume upload,
  job scraper, background tasks (submit->poll), config, layout
- client/README: React, Vite, routing, API communication, build, Vercel deploy
- CONTRIBUTING: drop obsolete Phase-1-only scope/task-ID framing; keep arch
  constraints + workflow; reflect current features and CI
- SETUP_GUIDE: fix stale notes (fail-fast on missing key, setup.sh does not run
  migrations), add CAREER_AGENT_MODEL + provider note + cache TTL, update verify steps
- API_CONTRACTS + DATABASE: jobId optional, new result shape (mode/careerReport/
  jobMatch), analyses.job_id nullable + career_report column + migration 0002
- ci.yml comment de-references old phase plan; add MIT LICENSE
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
interview-iq Ready Ready Preview, Comment Jun 26, 2026 7:50pm

@4reeb-5yed
4reeb-5yed merged commit d4e02d2 into main Jun 26, 2026
3 of 4 checks passed

This branch was successfully deployed

1 active deployment
Preview — 9ad1a213 Deployed Jun 26, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants