Jobber/docs-site/docs/intro.md
ilia 57b054caa0
Some checks failed
CI / Linting (Biome) (push) Failing after 40s
CI / Tests (push) Successful in 5m15s
CI / Type Check (adzuna-extractor) (push) Successful in 1m9s
CI / Type Check (gradcracker-extractor) (push) Successful in 1m13s
CI / Type Check (hiringcafe-extractor) (push) Successful in 1m9s
CI / Type Check (orchestrator) (push) Successful in 1m27s
CI / Type Check (startupjobs-extractor) (push) Successful in 1m10s
CI / Type Check (ukvisajobs-extractor) (push) Successful in 1m10s
CI / Documentation (push) Successful in 1m59s
fix(docs): use /docs/next paths for duplicate-jobs links
Fix Docusaurus broken-link errors in intro and orchestrator pages.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-16 18:51:41 -04:00

165 lines
7.0 KiB
Markdown

---
id: intro
title: JobOps Documentation
description: Documentation index for setup, features, extractors, and common problems.
sidebar_position: 1
slug: /
---
Welcome to the JobOps documentation. This site contains guides for setup, configuration, and day-to-day usage.
## What JobOps does
JobOps is a self-hosted job search operations stack: it **discovers** roles from many boards, **filters** them to your geography and profile, **scores** fit, **tailors** resumes and PDFs, and **tracks** applications after you apply.
In practice:
1. **Discover** — Run a pipeline against LinkedIn, Indeed, Glassdoor, QAJobsBoard, Canadian boards, and other extractors using your search terms and country (for example Canada, remote-only QA).
2. **Filter** — Drop unwanted countries, companies, co-op/intern patterns, non-matching locations, expired LinkedIn reposts, and duplicate postings you already skipped or applied to.
3. **Review** — Work through **Discovered** and **Ready** in the Orchestrator; skip noise, move strong fits to Ready, generate tailored PDFs.
4. **Apply & track** — Mark applied, sync Gmail for recruiter mail, and use the in-progress board and analytics.
Key filters and quality controls are documented under [Core Features](#feature-documentation) — especially [Blocked countries](/docs/next/features/blocked-countries), [Company skip list](/docs/next/features/company-skip-list), and [Duplicate job detection](/docs/next/features/duplicate-jobs).
## Getting Started
- **<a href="/docs/next/getting-started/self-hosting" data-umami-event="docs_intro_self_hosting_click">Self-Hosting Guide</a>**
- Docker setup instructions
- Gmail OAuth configuration for email tracking
- Environment variables reference
- Demo mode deployment
- **[Database Backups](/docs/next/getting-started/database-backups)**
- Automatic backup scheduling and retention
- Manual backup creation/deletion
- Restore workflow and troubleshooting
## Workflows
- **[Find Jobs and Apply Workflow](/docs/next/workflows/find-jobs-and-apply-workflow)**
- Run pipeline first, then review discovered and ready jobs
- Use fit assessment and score to prioritize applications
- Mark jobs as applied to trigger webhooks and analytics
- **[Post-Application Workflow](/docs/next/workflows/post-application-workflow)**
- Track events manually for direct control
- Or configure automatic Gmail sync and inbox review
- Move confirmed updates into in-progress tracking
## Feature Documentation
- **[Orchestrator](/docs/next/features/orchestrator)**
- Job states explained (`discovered`, `ready`, `applied`, etc.)
- The ready flow (manual vs auto)
- PDF generation and regeneration
- Post-application tracking overview
- **[Pipeline Run](/docs/next/features/pipeline-run)**
- Run modal controls (`Automatic` vs `Manual`)
- Presets, source/country compatibility, and advanced settings
- Run estimate and start conditions
- **[Job Search Bar](/docs/next/features/job-search-bar)**
- Open with `Cmd+K` / `Ctrl+K` or the Search button
- Fuzzy search across title, company, and location
- Use `@status` lock syntax to scope results quickly
- **[Keyboard Shortcuts](/docs/next/features/keyboard-shortcuts)**
- Full Jobs-page shortcut reference by context
- `?` shortcut help dialog and `Control` hint bar behavior
- Tab-specific actions like skip, move to ready, and mark applied
- **[Duplicate job detection](/docs/next/features/duplicate-jobs)**
- Cross-source dedup by employer and title
- Auto-skip repeats when you skip or apply
- Hide duplicate open rows in the Jobs list
- **[Blocked countries](/docs/next/features/blocked-countries)**
- Block listings that mention specific countries
- Canada-only (and other) search geography enforcement
- **[Company skip list](/docs/next/features/company-skip-list)**
- Block employers by keyword during discovery
- **[Multi-Select and Bulk Actions](/docs/next/features/multi-select-and-bulk-actions)**
- Select many jobs using row checkboxes or select-all
- Run bulk move, skip, and rescore actions from the floating action bar
- Keyboard support for select, clear, and fast bulk move-to-ready
- **[Settings](/docs/next/features/settings)**
- LLM provider/model and task-specific overrides
- Webhooks, service accounts, and basic auth controls
- Backup scheduling, scoring thresholds, and danger-zone cleanup tools
- **[Reactive Resume](/docs/next/features/reactive-resume)**
- Base resume selection and RxResume integration
- Project inclusion controls (must-include, AI-selectable, max)
- PDF generation behavior and troubleshooting
- **[Applications Overview](/docs/next/features/overview)**
- Applications-per-day trend
- Conversion analytics and funnel
- Duration window controls (`7d`, `14d`, `30d`, `90d`)
- **[In Progress Board](/docs/next/features/in-progress-board)**
- Pre-application vs post-application workflow split
- Kanban tracking for higher-attention opportunities
- Drag-and-drop stage management
- **[Ghostwriter](/docs/next/features/ghostwriter)**
- One persistent conversation per job
- Streaming responses, stop, and regenerate
- Markdown rendering and drawer behavior
- Writing style settings impact
- **[Post-Application Tracking](/docs/next/features/post-application-tracking)**
- How the Smart Router AI works
- Gmail integration setup
- Using the Tracking Inbox
- Privacy and security details
- API reference
- **[Visa Sponsors](/docs/next/features/visa-sponsors)**
- Search licensed UK sponsor organizations
- Review company routes and sponsor ratings
- Trigger manual data refresh
## Extractors
- **[Extractors Overview](/docs/next/extractors/overview)**
- **[Gradcracker](/docs/next/extractors/gradcracker)**
- **[UKVisaJobs](/docs/next/extractors/ukvisajobs)**
- **[JobSpy](/docs/next/extractors/jobspy)**
- **[Manual Import](/docs/next/extractors/manual)**
## Quick Reference
### Main Components
- **Orchestrator**: Main application (UI, API, database)
- **Extractors**: Specialized job crawlers
- **Shared**: Common types and utilities
### Key Features
1. **Job discovery**: Find roles from multiple extractors in one pipeline run.
2. **Geography and quality filters**: Block countries and employers, enforce search-country allow-lists, remote-only runs, and profile deal-breakers.
3. **Duplicate suppression**: Collapse cross-board reposts; remember skips and applications.
4. **AI scoring**: Rank jobs by suitability for your profile.
5. **Resume tailoring**: Generate custom resumes and PDFs per job (RxResume).
6. **Application tracking**: Applied status, post-application Gmail sync, in-progress board, and analytics.
## Contributing to Documentation
When adding user-visible behavior:
1. Update the relevant feature page in current docs.
2. Add API documentation where relevant.
3. Keep examples realistic and copy-pasteable.
4. Include diagrams for non-trivial workflows.
## Support
- Open an [issue](https://github.com/DaKheera47/job-ops/issues) for documentation errors.
- Check these docs before opening support requests.