Crain IQ Documentation

This folder (/docs/**) is the canonical documentation source for this repo.

• In-app docs at /docs (when running the app) should render content from this folder.
• Anything in /docs-archive/** is historical and may be inaccurate.

Getting started

• Getting Started

Architecture

• Architecture Overview
• System Design
• Data Flow
• Temporal Search
• Session Context
• Multi-brand Routing
• Streaming responses
• Streaming refactor report (archived)

API

• API Home
• V2 Ask
• V2 Search
• Health + Test
• Feedback
• Sessions

RAG pipeline

• Ranking and scoring
• Reranking
• Citation validation
• QA prompt

Security, reliability, and observability

• Security
• Authentication integration
• Circuit breaker
• Observability

Data + database

• Data dictionary
• Database folder guide

Development + deployment

• Development
• Deployment

Operations

• Operations overview
• Ingestion runbook - Scheduled content ingestion
• FTS index runbook - Full-text search index maintenance

Evaluation + testing

• Evaluation
• Testing

Archived documentation

See /docs-archive for historical/superseded docs.

Documentation standards

• Keep content concise and factual.
• Prefer linking to code over duplicating code.
• Avoid emojis (they create noise and tend to age poorly).
• When docs and code conflict, update docs.

Last updated: 2025-12-30