Specifications

This folder contains the documentation source for Ingest. The recommended reading path starts with concepts, then moves into task guides, and ends with API reference.

Start here

1. Overview
2. Application Model
3. Data Surfaces
4. Request Lifecycle
5. Routing Patterns
6. Guides
7. API Reference

Sections

• Overview explains what Ingest is optimizing for.
• Concepts explains how the system works.
• Guides explains how to accomplish common tasks.
• API Reference is for exact class and method lookup.
• Examples points to full workspaces in examples/.

Notes

• docs/ is intentionally free for future GitHub Pages content.
• Example applications support the docs, but they are no longer the primary explanation layer.