From 5819cff3ae623ae9d39c5b2c9c649f4b1cc7bc8a Mon Sep 17 00:00:00 2001 From: ReachableCEO Date: Wed, 15 Oct 2025 13:48:15 -0500 Subject: [PATCH] docs: align output flow with single-job process --- README.md | 5 +++-- output/README.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1796e8f..a028e23 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # RCEO-AI ResumeCustomizer -A system that uses agentic AI to turn a Markdown base resume and job descriptions into tailored DOCX/PDF deliverables. +A two-part workflow that uses agentic AI to refine a base Markdown resume for a single job description at a time, then renders the approved result into DOCX/PDF deliverables. ## Repository Layout -- `output/` – conversion pipeline that watches for approved Markdown resumes, renders export formats, and archives the sources. See the detailed [output pipeline guide](output/README.md). +- `input/` – (in progress) tooling that prepares job-specific Markdown resumes. +- `output/` – conversion pipeline that watches for an approved Markdown resume, renders export formats, and archives the sources. See the detailed [output pipeline guide](output/README.md). Additional documentation will grow alongside the `input/` tooling as that side of the project is finalized. diff --git a/output/README.md b/output/README.md index 130ebc2..089e401 100644 --- a/output/README.md +++ b/output/README.md @@ -1,6 +1,6 @@ # Output Pipeline Overview -This directory contains the post-processing side of ResumeCustomizer. It is responsible for taking job-targeted Markdown resumes produced elsewhere in the system and turning them into printable DOCX/PDF artifacts. +This directory contains the post-processing side of ResumeCustomizer. It is responsible for taking a job-targeted Markdown resume produced elsewhere in the system and turning it into printable DOCX/PDF artifacts. ## Directory Layout - `ForRelease/inbox`: drop a single `*.md` file here to trigger conversion. @@ -20,7 +20,7 @@ cd output/Docker The script detects either the Docker Compose plugin or the legacy `docker-compose` binary and forwards any additional arguments you supply (`down`, `logs`, etc.). The stack registers under the project name `RCEO-AI-ResumeCustomizer-Output`, and the primary container is `RCEO-AI-ResumeCustomizer-Output-Processor`. ## What the Watcher Does -1. Polls `ForRelease/inbox` every few seconds for Markdown files. +1. Polls `ForRelease/inbox` every few seconds for a single Markdown resume. 2. Runs Pandoc using the shared DOCX and LaTeX templates to generate DOCX/PDF. 3. Drops the exports into the timestamped folder under `ForRelease/outbox`. 4. Moves the original Markdown into the matching timestamp folder under `ForRelease/processed`.