* don't run for generated docusaurus * format * workflow to autoupdate docs version * fix versioning * add link back to app * remove old docs * html link??? * don't track .docusaurus * documantation build
2.5 KiB
2.5 KiB
id, title, description, sidebar_position
| id | title | description | sidebar_position |
|---|---|---|---|
| orchestrator | Orchestrator | Job states, ready flow, and PDF generation/regeneration behavior. | 1 |
This guide explains job states, how jobs become ready, and how PDF generation works.
Job states
discovered: Found by crawler/import, not tailored yet.processing: Tailoring and/or PDF generation in progress.ready: Tailored PDF generated and ready to apply.applied: Marked as applied.skipped: Explicitly excluded from active queue.expired: Deadline passed.
Intended ready flow
1) Manual flow
- Job starts in
discovered. - Open in Discovered panel and choose Tailor.
- Edit JD/tailored fields/project picks.
- Click Finalize & Move to Ready.
2) Auto flow
- Pipeline scores discovered jobs.
- Top jobs above threshold are auto-processed.
- Jobs move directly to
readywith generated PDFs.
Ghostwriter
Ghostwriter is available in discovered and ready job views.
For details, see Ghostwriter.
Generating PDFs (first time)
PDF generation uses:
- Base resume selected from RxResume
- Job description
- Tailored summary/headline/skills/projects
Common paths:
- Discovered → Tailor → Finalize
POST /api/jobs/:id/process
- Ready → Regenerate PDF
POST /api/jobs/:id/generate-pdf
Regenerating PDFs after edits
If JD or tailoring changes, regenerate PDF to keep output in sync.
API flow
PATCH /api/jobs/:id
{
"jobDescription": "<new JD>",
"tailoredSummary": "<optional>",
"tailoredHeadline": "<optional>",
"tailoredSkills": "[{\"name\":\"Backend\",\"keywords\":[\"TypeScript\",\"Node.js\"]}]",
"selectedProjectIds": "p1,p2"
}
POST /api/jobs/:id/summarize?force=true
POST /api/jobs/:id/generate-pdf
Post-application tracking
For inbox routing flow and setup, see Post-Application Tracking.
Notes and gotchas
processingis transient. On PDF failure, job reverts todiscovered.- PDFs are served at
/pdfs/resume_<jobId>.pdfwith cache-bust onupdatedAt. skipped/appliedjobs can be reopened by patchingstatustodiscovered.
External payload and sanitization defaults
- LLM prompts send minimized profile/job fields.
- Webhooks are sanitized and whitelisted by default.
- Logs and error details are redacted/truncated by default.
- Correlation fields include
requestId, and when availablepipelineRunIdandjobId.