Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

careers-engine home page

Docs

Getting Started

Introduction
Installation
Configuration
Running Locally
Discord Bot Setup
GitHub Actions
First Publish

Architecture

Overview
Ingestion Pipeline
Publishing Pipeline
Storage
Company Branding
Employment Inference
Repository Layout

Developer Guide

Contributing
Adding a Source
Adding a Company
Adding a Logo
Adding an Employment Rule
Testing
Release Process

Reference

Configuration
Environment Variables
JSON Schema
CLI
Workflows

API

Models
Storage
Parsers
Discord
Sources

Discord
GitHub

careers-engine home page

Discord
GitHub
GitHub

API

Models

Data model reference.

Documentation for this section is currently under development. This page will document the core data models used across careers-engine.

Storage API reference.

⌘I

x github linkedin discord

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.