d0b4091a60
* initlal commit * Ghostwriter always enabled * rename code * ghostwriter panel * separate component * ui improvements * single thread * copy improvement * dont pop up keyboard shortcuts * markdown renderer * ghostwriter button placement * better UX * ghostwriter copy * meta shortcut * better settings menu * formatting * doocumentation * add tests * race condition * race condition 2 * pass title * more comments * comments * formtting
JobOps Documentation
Welcome to the JobOps documentation. This folder contains comprehensive guides for setting up, configuring, and using JobOps.
Getting Started
- Self-Hosting Guide - Deploy JobOps with Docker Compose
- Docker setup instructions
- Gmail OAuth configuration for email tracking
- Environment variables reference
- Demo mode deployment
Feature Documentation
-
Orchestrator - Core job workflow and PDF generation
- Job states explained (discovered, ready, applied, etc.)
- The "Ready" flow (manual vs auto)
- PDF generation and regeneration
- Post-application tracking overview
-
Ghostwriter - Context-aware per-job chat assistant
- One persistent conversation per job
- Streaming responses, stop, and regenerate
- Markdown rendering and drawer UX behavior
- Writing style settings impact
-
Post-Application Tracking - Email-to-job matching
- How the Smart Router AI works
- Gmail integration setup
- Using the Tracking Inbox
- Privacy and security details
- API reference
Extractors
JobOps uses specialized extractors to gather jobs from different sources:
- Extractors Overview - Architecture and how extractors work
- Gradcracker - UK graduate jobs and internships
- UKVisaJobs - UK visa sponsorship jobs
- JobSpy - Multi-platform job aggregator (Indeed, LinkedIn, etc.)
- Manual Import - Import jobs from URLs or text
Quick Reference
Main Components
- Orchestrator - Main application (UI, API, database)
- Extractors - Specialized job crawlers
- Shared - Common types and utilities
Key Features
- Job Discovery - Automatically find jobs from multiple sources
- AI Scoring - Rank jobs by suitability for your profile
- Resume Tailoring - Generate custom resumes for each job
- PDF Export - Create tailored PDFs via RxResume integration
- Application Tracking - Monitor your applied jobs
- Email Tracking - Auto-track post-application responses (interviews, offers, rejections)
Documentation Structure
documentation/
├── self-hosting.md # Deployment guide
├── orchestrator.md # Core workflow documentation
├── ghostwriter.md # Ghostwriter feature documentation
├── post-application-tracking.md # Email tracking feature
└── extractors/ # Job source extractors
├── README.md
├── gradcracker.md
├── jobspy.md
├── manual.md
├── ukvisajobs.md
└── gradcracker.md
Contributing to Documentation
When adding new features:
- Update the relevant feature documentation
- Add API endpoint documentation to orchestrator README
- Update this index if adding new docs
- Include mermaid diagrams for complex workflows
- Provide practical examples
Support
- Open an issue for documentation errors
- Check existing docs before asking questions
- See main README for general project info