From cc14c6e2e2320edfada5c19c032aedd626543784 Mon Sep 17 00:00:00 2001 From: Prad Nukala Date: Tue, 30 Jun 2026 11:24:15 -0400 Subject: [PATCH] docs(AGENTS.md): add detailed documentation for AGENTS.md files in subdirectories --- docs/AGENTS.md | 13 +++++----- docs/about/AGENTS.md | 33 ++++++++++++++++++++++++++ docs/experience/AGENTS.md | 50 +++++++++++++++++++++++++++++++++++++++ docs/projects/AGENTS.md | 50 +++++++++++++++++++++++++++++++++++++++ docs/skills/AGENTS.md | 32 +++++++++++++++++++++++++ 5 files changed, 171 insertions(+), 7 deletions(-) create mode 100644 docs/about/AGENTS.md create mode 100644 docs/experience/AGENTS.md create mode 100644 docs/projects/AGENTS.md create mode 100644 docs/skills/AGENTS.md diff --git a/docs/AGENTS.md b/docs/AGENTS.md index 1916496..ed18d73 100644 --- a/docs/AGENTS.md +++ b/docs/AGENTS.md @@ -1,5 +1,5 @@ - + # docs @@ -7,15 +7,14 @@ Structured YAML source material for the résumés — the canonical, role-agnostic record of Prad's career. The `src/*.tex` variants are hand-curated *from* this data; nothing here is generated and nothing generates the `.tex`. Treat these files as the single source of truth: when a fact changes (a date, a metric, a new project), update it here first, then reflect it in the relevant templates. ## Subdirectories -Each subdirectory holds one flat collection of like-shaped YAML files (no nesting, no per-file AGENTS.md — they share a schema described below). +Each subdirectory holds one flat collection of like-shaped YAML files (no nesting). Each has its own AGENTS.md describing its schema. | Directory | Purpose | |-----------|---------| -| `experience/` | One file per employer (`sonr`, `leidos`, `britetwist`, `hobsons`, `unissant`). Fields: `title`, `company`, `start`/`end`, `location`, `description` (bullets), `skills`, `projects` (refs). | -| `projects/` | One file per project (16). Fields: `title`, `start`/`end`, `project-url`, `associated-with`, `skills`, `description` (bullets). Sonr-era projects (appchain, beam-chat, cryptography-library, client-sdk, token-economics, decentralized-airdrop, ecosystem-devrel) carry the strongest material. | -| `skills/` | `languages.yml` (expert/strong/familiar tiers), `frameworks.yml` (grouped flat list), `methodology.yml` (flat list). These feed the Skills column in the templates. | -| `recognition/` | `honors.yml` (e.g. MIT Sloan guest lecture) and `organizations.yml` (W3C, DIF working groups). Feed the Honors/Organizations blocks. | -| `information/` | `profile.yml` (name, contact, role summaries) and `education.yml` (VCU, Applied Math). | +| `experience/` | One file per employer — `sonr`, `leidos`, `britetwist`, `hobsons`, `unissant` (see `experience/AGENTS.md`). | +| `projects/` | One file per project, 16 total (see `projects/AGENTS.md`). Sonr-era projects carry the strongest material. | +| `skills/` | `languages.yml`, `frameworks.yml`, `methodology.yml` — feed the Skills column (see `skills/AGENTS.md`). | +| `about/` | `profile.yml`, `education.yml`, `honors.yml`, `organizations.yml` — identity, contact, and the Honors/Organizations blocks (see `about/AGENTS.md`). | ## For AI Agents diff --git a/docs/about/AGENTS.md b/docs/about/AGENTS.md new file mode 100644 index 0000000..93c319f --- /dev/null +++ b/docs/about/AGENTS.md @@ -0,0 +1,33 @@ + + + +# about + +## Purpose +Identity, contact, education, and recognition — the role-independent blocks shared by every résumé variant. (Consolidates what older docs called `information/` + `recognition/`.) + +## Key Files +| File | Description | +|------|-------------| +| `profile.yml` | Name, contact (email/phone/website/linkedin/github/twitter), and per-role `summary` entries used as the résumé header blurb. | +| `education.yml` | VCU, Applied Mathematics (2017–2020), coursework skills, `activities`, and refs to school-era `projects`. | +| `honors.yml` | List of honors (e.g. MIT Sloan guest lecture) — feeds the Honors block. | +| `organizations.yml` | Standards-body memberships (W3C, DIF) — feeds the Organizations block. | + +## For AI Agents + +### Working In This Directory +- `honors.yml` and `organizations.yml` are top-level YAML *lists* of objects, not maps — keep that shape. +- `education.yml` `projects:` uses relative refs into `../projects/`. Keep valid. +- `profile.yml` `summary` is a list of `{role, summary}` — one tailored blurb per résumé variant; match a new variant's title here. + +### Testing Requirements +```bash +python3 -c "import yaml; yaml.safe_load(open('.yml'))" +``` + +## Dependencies +### Internal +- Consumed by `../../src/*.tex` (Contact / Honors / Organizations / Education blocks, identical across variants) by hand. + + diff --git a/docs/experience/AGENTS.md b/docs/experience/AGENTS.md new file mode 100644 index 0000000..bbae450 --- /dev/null +++ b/docs/experience/AGENTS.md @@ -0,0 +1,50 @@ + + + +# experience + +## Purpose +One YAML file per employer — the canonical record of each role Prad has held. Templates draw experience bullets from here; nothing is generated. + +## Key Files +| File | Description | +|------|-------------| +| `sonr.yml` | Co-Founder / CEO at Sonr (2021–). Richest entry — DIDs, WebAuthn, Matrix, Cosmos L1, fundraising. Lists 7 project refs. | +| `britetwist.yml` | Consumer mobile work (1M+ downloads era). | +| `leidos.yml` | Defense/government engineering. | +| `hobsons.yml` | Earlier engineering role. | +| `unissant.yml` | Earlier engineering role. | + +## Schema +```yaml +title: Co-Founder / CEO # role title +company: Sonr +start: 2021-03-01 # ISO YYYY-MM-DD; omit end: for Present +end: 2020-12-01 # optional +location: New York, USA +profile-heading: ... # optional one-liner +description: | # block scalar of "- " bullets + - Bullet… +skills: # canonical names, reused across files + - React Native +projects: # relative refs into ../projects/ + - ../projects/beam-chat.yml +``` + +## For AI Agents + +### Working In This Directory +- `projects:` and any cross-refs use relative paths (`../projects/.yml`). Keep valid on rename/move. +- Skill names must match the canonical spelling used elsewhere (`Decentralized Identifiers (DIDs)`, `WebAssembly (WASM)`) so they dedupe across files. +- `description` bullets are the raw pool; templates condense them to fit one page — do not assume verbatim use. + +### Testing Requirements +```bash +python3 -c "import yaml; yaml.safe_load(open('.yml'))" +``` + +## Dependencies +### Internal +- Referenced by `../projects/*.yml` via `associated-with`; consumed by `../../src/*.tex` by hand. + + diff --git a/docs/projects/AGENTS.md b/docs/projects/AGENTS.md new file mode 100644 index 0000000..53c9e7a --- /dev/null +++ b/docs/projects/AGENTS.md @@ -0,0 +1,50 @@ + + + +# projects + +## Purpose +One YAML file per project (16 total) — the portfolio pool the résumé templates select from per role. Each project links back to the experience or education entry it belongs to. + +## Key Files +Sonr-era (strongest material, `associated-with: ../experience/sonr.yml`): +| File | Description | +|------|-------------| +| `appchain.yml` | Layer-1 Cosmos blockchain & DID ecosystem — gasless onboarding, UCAN/DWN, EVM+CosmWasm. | +| `beam-chat.yml` | Beam — E2EE React Native messaging on the Matrix protocol, WebAuthn passkeys, DIDs. | +| `cryptography-library.yml` | ZKP (Bulletproofs) & MPC/DKG infrastructure in Go. | +| `client-sdk.yml` · `motr-sdk` | Client/SDK surface. | +| `token-economics.yml` · `decentralized-airdrop.yml` · `ecosystem-devrel.yml` | Token design, airdrop, devrel. | + +Earlier/consumer apps: `floadt`, `likely`, `pool`, `spacebolt`, `superball`, `swiper-no-mauling`, `timeboard`, `voluntree`, `yue` (several `associated-with: ../about/education.yml`). + +## Schema +```yaml +title: Beam — Lead Architect | E2EE Messaging · Matrix Protocol · DID +start: 2022-08-01 # ISO; omit end: for ongoing +end: 2025-08-01 # optional +project-url: https://... # repo, live demo, or video — proof-of-work link +associated-with: ../experience/sonr.yml # required relative ref +skills: # closed set of 4–6 canonical names + - React Native +description: | # block scalar of "- " bullets, STAR pattern + - Bullet… +``` + +## For AI Agents + +### Working In This Directory +- `associated-with` is required and uses a relative path into `../experience/` or `../about/`. Keep valid. +- `title` follows `[Product] — [Role] | [Tech · Tech · Tech]`; `skills` is a tight closed set reused across siblings for keyword consistency (the `/linkedin-project` skill enforces this). +- **Never invent metrics.** Bullets carry only user-confirmed numbers; otherwise stay qualitative. + +### Testing Requirements +```bash +python3 -c "import yaml; yaml.safe_load(open('.yml'))" +``` + +## Dependencies +### Internal +- Each file points to `../experience/*.yml` or `../about/education.yml`; consumed by `../../src/*.tex` by hand. + + diff --git a/docs/skills/AGENTS.md b/docs/skills/AGENTS.md new file mode 100644 index 0000000..9b616f8 --- /dev/null +++ b/docs/skills/AGENTS.md @@ -0,0 +1,32 @@ + + + +# skills + +## Purpose +The skill inventory that feeds the Skills column of every résumé variant. Three files, three different shapes. + +## Key Files +| File | Shape | Description | +|------|-------|-------------| +| `languages.yml` | Tiered map | `expert` / `strong` / `familiar` lists of programming languages. | +| `frameworks.yml` | Flat list, `#`-commented groups | Mobile / Web / Blockchain / Infrastructure sections in one sequence. | +| `methodology.yml` | Flat list | Practices and disciplines (CI/CD, TDD, System Architecture, …). | + +## For AI Agents + +### Working In This Directory +- Keep skill names spelled canonically and consistently with `../experience/*.yml` and `../projects/*.yml` so they match across the corpus. +- `frameworks.yml` uses YAML comments (`# Mobile`) as visual grouping only — they are not data; preserve them when editing. +- `languages.yml` tiers are subjective rankings; don't promote/demote without reason. + +### Testing Requirements +```bash +python3 -c "import yaml; yaml.safe_load(open('.yml'))" +``` + +## Dependencies +### Internal +- Consumed by `../../src/*.tex` (Skills column) by hand. No generation. + +