Images in documentation (#173)
* docs images * images in documentation * logos * update colours to orange-related
@ -9,6 +9,8 @@ sidebar_position: 3
|
|||||||
|
|
||||||
The In Progress Board is a kanban view for jobs that have moved beyond initial application.
|
The In Progress Board is a kanban view for jobs that have moved beyond initial application.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
It groups jobs into post-application lanes:
|
It groups jobs into post-application lanes:
|
||||||
|
|
||||||
- Recruiter Screen
|
- Recruiter Screen
|
||||||
|
|||||||
@ -7,6 +7,8 @@ sidebar_position: 3
|
|||||||
|
|
||||||
The Job Search Bar is the quickest way to jump to any job from the Jobs page.
|
The Job Search Bar is the quickest way to jump to any job from the Jobs page.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Open it
|
## Open it
|
||||||
|
|
||||||
Use either:
|
Use either:
|
||||||
|
|||||||
@ -9,6 +9,8 @@ sidebar_position: 1
|
|||||||
|
|
||||||
The Orchestrator is the primary jobs workspace in JobOps.
|
The Orchestrator is the primary jobs workspace in JobOps.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
It controls:
|
It controls:
|
||||||
|
|
||||||
- job lifecycle states
|
- job lifecycle states
|
||||||
|
|||||||
@ -9,12 +9,20 @@ sidebar_position: 1
|
|||||||
|
|
||||||
The Overview page is the analytics dashboard for your pipeline outcomes.
|
The Overview page is the analytics dashboard for your pipeline outcomes.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
It visualizes:
|
It visualizes:
|
||||||
|
|
||||||
- Applications per day
|
- Applications per day
|
||||||
- Application-to-response conversion
|
- Application-to-response conversion
|
||||||
- Funnel progression (Applied, Screening, Interview, Offer, Rejected)
|
- Funnel progression (Applied, Screening, Interview, Offer, Rejected)
|
||||||
|
|
||||||
|
### Graph-level views
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Why it exists
|
## Why it exists
|
||||||
|
|
||||||
The page helps you measure whether your current sourcing and tailoring approach is producing responses, not just applications.
|
The page helps you measure whether your current sourcing and tailoring approach is producing responses, not just applications.
|
||||||
|
|||||||
@ -7,6 +7,8 @@ sidebar_position: 3
|
|||||||
|
|
||||||
The Tracking Inbox monitors Gmail for job-application responses and updates timelines.
|
The Tracking Inbox monitors Gmail for job-application responses and updates timelines.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
1. Scans Gmail for recruitment-related emails
|
1. Scans Gmail for recruitment-related emails
|
||||||
|
|||||||
@ -9,6 +9,8 @@ sidebar_position: 2
|
|||||||
|
|
||||||
The Settings page is the control center for app-wide behavior.
|
The Settings page is the control center for app-wide behavior.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
It lets you configure:
|
It lets you configure:
|
||||||
|
|
||||||
- LLM provider and models
|
- LLM provider and models
|
||||||
@ -36,6 +38,8 @@ Settings gives you runtime overrides for the key parts of discovery, scoring, ta
|
|||||||
|
|
||||||
### Model
|
### Model
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Choose provider (`openrouter`, `lmstudio`, `ollama`, `openai`, `gemini`)
|
- Choose provider (`openrouter`, `lmstudio`, `ollama`, `openai`, `gemini`)
|
||||||
- Set provider-specific base URL/API key when required
|
- Set provider-specific base URL/API key when required
|
||||||
- Configure default model plus task-specific overrides:
|
- Configure default model plus task-specific overrides:
|
||||||
@ -45,16 +49,22 @@ Settings gives you runtime overrides for the key parts of discovery, scoring, ta
|
|||||||
|
|
||||||
### Webhooks
|
### Webhooks
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Pipeline status webhook: called on run completion/failure
|
- Pipeline status webhook: called on run completion/failure
|
||||||
- Job completion webhook: called when a job is marked applied
|
- Job completion webhook: called when a job is marked applied
|
||||||
- Optional webhook secret (sent as bearer token)
|
- Optional webhook secret (sent as bearer token)
|
||||||
|
|
||||||
### Display Settings
|
### Display Settings
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Toggle visa sponsor badge visibility in job lists/details
|
- Toggle visa sponsor badge visibility in job lists/details
|
||||||
|
|
||||||
### Ghostwriter
|
### Ghostwriter
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Set global writing defaults:
|
- Set global writing defaults:
|
||||||
- Tone
|
- Tone
|
||||||
- Formality
|
- Formality
|
||||||
@ -63,6 +73,8 @@ Settings gives you runtime overrides for the key parts of discovery, scoring, ta
|
|||||||
|
|
||||||
### Reactive Resume
|
### Reactive Resume
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Select a template/base resume
|
- Select a template/base resume
|
||||||
- Configure project selection behavior:
|
- Configure project selection behavior:
|
||||||
- Max projects
|
- Max projects
|
||||||
@ -74,10 +86,12 @@ Settings gives you runtime overrides for the key parts of discovery, scoring, ta
|
|||||||
- Configure service accounts:
|
- Configure service accounts:
|
||||||
- RxResume email/password
|
- RxResume email/password
|
||||||
- UKVisaJobs email/password
|
- UKVisaJobs email/password
|
||||||
- Optional basic authentication for write operations
|
- Optional basic authentication for write operations
|
||||||
|
|
||||||
### Backup
|
### Backup
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Enable/disable automatic daily backups
|
- Enable/disable automatic daily backups
|
||||||
- Configure backup hour (UTC) and max retained backups
|
- Configure backup hour (UTC) and max retained backups
|
||||||
- Create or delete backups manually
|
- Create or delete backups manually
|
||||||
@ -85,12 +99,16 @@ Settings gives you runtime overrides for the key parts of discovery, scoring, ta
|
|||||||
|
|
||||||
### Scoring Settings
|
### Scoring Settings
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Penalize missing salary data
|
- Penalize missing salary data
|
||||||
- Set penalty amount
|
- Set penalty amount
|
||||||
- Optional auto-skip threshold for low-score jobs
|
- Optional auto-skip threshold for low-score jobs
|
||||||
|
|
||||||
### Danger Zone
|
### Danger Zone
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
- Clear jobs by selected statuses
|
- Clear jobs by selected statuses
|
||||||
- Clear jobs below a score threshold
|
- Clear jobs below a score threshold
|
||||||
- Clear the full database
|
- Clear the full database
|
||||||
|
|||||||
@ -14,7 +14,7 @@ const siteBaseUrl = normalizedBaseUrl.endsWith("/")
|
|||||||
const config: Config = {
|
const config: Config = {
|
||||||
title: "JobOps Documentation",
|
title: "JobOps Documentation",
|
||||||
tagline: "Self-hosted job search automation docs",
|
tagline: "Self-hosted job search automation docs",
|
||||||
favicon: "img/favicon.ico",
|
favicon: "img/favicon.png",
|
||||||
future: {
|
future: {
|
||||||
v4: true,
|
v4: true,
|
||||||
},
|
},
|
||||||
@ -54,7 +54,7 @@ const config: Config = {
|
|||||||
title: "JobOps Docs",
|
title: "JobOps Docs",
|
||||||
logo: {
|
logo: {
|
||||||
alt: "JobOps",
|
alt: "JobOps",
|
||||||
src: "img/logo.svg",
|
src: "img/favicon.png",
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
|
|||||||
@ -6,25 +6,25 @@
|
|||||||
|
|
||||||
/* You can override the default Infima variables here. */
|
/* You can override the default Infima variables here. */
|
||||||
:root {
|
:root {
|
||||||
--ifm-color-primary: #2e8555;
|
--ifm-color-primary: oklch(0.6171 0.1375 39.0427);
|
||||||
--ifm-color-primary-dark: #29784c;
|
--ifm-color-primary-dark: oklch(0.58 0.1375 39.0427);
|
||||||
--ifm-color-primary-darker: #277148;
|
--ifm-color-primary-darker: oklch(0.56 0.1375 39.0427);
|
||||||
--ifm-color-primary-darkest: #205d3b;
|
--ifm-color-primary-darkest: oklch(0.52 0.1375 39.0427);
|
||||||
--ifm-color-primary-light: #33925d;
|
--ifm-color-primary-light: oklch(0.66 0.1375 39.0427);
|
||||||
--ifm-color-primary-lighter: #359962;
|
--ifm-color-primary-lighter: oklch(0.69 0.1375 39.0427);
|
||||||
--ifm-color-primary-lightest: #3cad6e;
|
--ifm-color-primary-lightest: oklch(0.73 0.1375 39.0427);
|
||||||
--ifm-code-font-size: 95%;
|
--ifm-code-font-size: 95%;
|
||||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||||
[data-theme="dark"] {
|
[data-theme="dark"] {
|
||||||
--ifm-color-primary: #25c2a0;
|
--ifm-color-primary: oklch(0.6724 0.1308 38.7559);
|
||||||
--ifm-color-primary-dark: #21af90;
|
--ifm-color-primary-dark: oklch(0.63 0.1308 38.7559);
|
||||||
--ifm-color-primary-darker: #1fa588;
|
--ifm-color-primary-darker: oklch(0.6 0.1308 38.7559);
|
||||||
--ifm-color-primary-darkest: #1a8870;
|
--ifm-color-primary-darkest: oklch(0.56 0.1308 38.7559);
|
||||||
--ifm-color-primary-light: #29d5b0;
|
--ifm-color-primary-light: oklch(0.71 0.1308 38.7559);
|
||||||
--ifm-color-primary-lighter: #32d8b4;
|
--ifm-color-primary-lighter: oklch(0.75 0.1308 38.7559);
|
||||||
--ifm-color-primary-lightest: #4fddbf;
|
--ifm-color-primary-lightest: oklch(0.79 0.1308 38.7559);
|
||||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
||||||
}
|
}
|
||||||
|
|||||||
BIN
docs-site/static/img/favicon.png
Normal file
|
After Width: | Height: | Size: 192 KiB |
BIN
docs-site/static/img/features/in-progress-board.png
Normal file
|
After Width: | Height: | Size: 57 KiB |
BIN
docs-site/static/img/features/job-search-bar.png
Normal file
|
After Width: | Height: | Size: 123 KiB |
BIN
docs-site/static/img/features/orchestrator-jobs.png
Normal file
|
After Width: | Height: | Size: 135 KiB |
BIN
docs-site/static/img/features/overview-applications-graph.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
BIN
docs-site/static/img/features/overview-dashboard.png
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
docs-site/static/img/features/overview-funnel-graph.png
Normal file
|
After Width: | Height: | Size: 71 KiB |
BIN
docs-site/static/img/features/settings-backup-section.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
BIN
docs-site/static/img/features/settings-danger-zone-section.png
Normal file
|
After Width: | Height: | Size: 64 KiB |
BIN
docs-site/static/img/features/settings-display-section.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
docs-site/static/img/features/settings-ghostwriter-section.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
docs-site/static/img/features/settings-model-section.png
Normal file
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 69 KiB |
BIN
docs-site/static/img/features/settings-scoring-section.png
Normal file
|
After Width: | Height: | Size: 52 KiB |
BIN
docs-site/static/img/features/settings-webhooks-section.png
Normal file
|
After Width: | Height: | Size: 47 KiB |
BIN
docs-site/static/img/features/settings.png
Normal file
|
After Width: | Height: | Size: 92 KiB |
BIN
docs-site/static/img/features/tracking-inbox.png
Normal file
|
After Width: | Height: | Size: 92 KiB |