docs(AGENTS): add documentation for cv and latex resumes

This commit is contained in:
Prad Nukala
2026-06-25 14:29:58 -04:00
parent 7eaf2796d8
commit b656732886
5 changed files with 409 additions and 0 deletions
+48
View File
@@ -0,0 +1,48 @@
<!-- Generated: 2026-06-25 | Updated: 2026-06-25 -->
# cv
## Purpose
A multi-variant LaTeX résumé for Prad Nukala. Each variant is a self-contained `.tex` file under `src/`, targeting a different role (React Native, blockchain, cryptography, founding engineer). The raw career material lives as structured YAML in `docs/` and is hand-curated into the templates — nothing auto-generates the `.tex` from the YAML. Builds with **pdflatex** via a single glob-driven `Makefile`.
## Key Files
| File | Description |
|------|-------------|
| `Makefile` | Glob-driven build: every `src/*.tex``dist/*.pdf`. No per-variant edits needed. |
| `CLAUDE.md` | Guidance for Claude Code (build commands, architecture, one-page constraint). |
| `README.md` | Upstream Deedy-Resume README — historical, not a description of this repo. |
| `source.tex` | The original single-variant file the `src/` templates were derived from. Not built by the Makefile (which only globs `src/`). |
| `.gitignore` / `LICENSE` | Standard repo files. |
## Subdirectories
| Directory | Purpose |
|-----------|---------|
| `src/` | Role-specific résumé templates, one `.tex` per variant (see `src/AGENTS.md`). |
| `docs/` | Structured YAML source material — experience, projects, skills (see `docs/AGENTS.md`). |
| `dist/` | Build output (git-ignored). Created by `make`. |
## For AI Agents
### Working In This Directory
- **pdflatex, not XeLaTeX.** Templates use `inputenc`/`fontenc` with default Computer Modern — no fontspec, no bundled fonts, no bibtex.
- The Makefile auto-discovers variants. Adding `src/<name>.tex` gives you `make <name>`, `make preview V=<name>`, `make watch V=<name>` for free — no Makefile edit.
- **One-page constraint:** every variant must stay a single page. `paracol` silently overflows to page 2 if a column runs long.
### Testing Requirements
After any `.tex` change, rebuild and confirm page count:
```bash
make distclean && make <variant>
pdfinfo dist/<variant>.pdf | grep Pages # must read: Pages: 1
```
### Common Patterns
- Variants share an identical preamble and the role-independent blocks (Contact, Honors, Organizations, Education). Title, skill groups, experience bullets, and project ordering are what differ per role.
- Content is curated from `docs/` YAML by hand; keep the two in sync when editing either.
## Dependencies
### External
- TeX Live (`pdflatex`, `latexmk`) — build toolchain.
- `pdfinfo` (poppler-utils) — page-count verification.
<!-- MANUAL: Any manually added notes below this line are preserved on regeneration -->