Documentation
Reference Overview
Use this section when you need precise, system-level answers about how Digest Engine is named, structured, configured, and operated. Unlike the User Guide, these pages are meant to be a working reference for developers, operators, and advanced users who need exact definitions and implementation-facing details.
If you are browsing, start with the Table of Contents tab to move around the current page. If you are trying to find a specific system document, open the Files tab and jump directly to the reference page you need.
Core Reference Pages
- Glossary of Terms: Defines the shared language used across the product, docs, and codebase.
- Data Model Schema: Maps the main application models and explains the core project-scoping boundaries.
- API Reference: Documents the main REST surface, auth modes, and the project-scoped endpoint structure.
Engine Internals
- Ingestion Pipeline: Explains how content moves through ingestion, enrichment, retries, and batch processing.
- Core Algorithms: Describes the main scoring, embedding, centroid, and authority logic used by the engine.
- Skill Capabilities: Lists the prompt-driven skills, what they consume, what they return, and where the prompts live.
System Observability
- System Tunables & Configuration: Central reference for environment variables, thresholds, and runtime controls.
- Logging & Observability: Covers structured logging, traceability, metrics, dashboards, and telemetry retention.
Suggested Reading Paths
- Learning the platform vocabulary: Start with Glossary of Terms, then continue to Data Model Schema.
- Understanding request and data flow: Read API Reference, Ingestion Pipeline, and Core Algorithms.
- Operating and tuning the system: Read System Tunables & Configuration and Logging & Observability.
- Working on prompt behavior: Read Skill Capabilities alongside Ingestion Pipeline.
Keep this page as the starting point for reference material. When you need implementation detail instead of product guidance, the links above should get you to the right document quickly.