Skip to content

README migration map

Where each section of the old 72 KB README.md moved. The old file is preserved at tests/fixtures/old-readme.md (used by scripts/check_docs.py).

Old README section New page
Quick start (Docker, scripts/docker_e2e.py --keep, make demo) Quick start, Demo
Ingestion (fetch paths, seeds, limits, backoff) Sources and ingestion
Sources: management, API adapters and budgets Sources, Operations > Pipeline
Profiles, topics and the UI Profiles, topics and UI
Demo on Windows (no make) Demo
Stories: text extraction and clustering Text extraction, Clustering
Tuning clustering Clustering > Tuning
Web-search enrichment (overview) Enrichment overview
"How enrichment works" / acceptance rules B/C/D Filters and acceptance
Queries, signal tokens, skips Queries and signal rules
Deny lists, flagged domains, block-domain, aliases Source quality
Provider config, pacing, budgets, evaluate/dry-run Providers, Operating
Background and context links Context overview, Configuration, Operating
Card images Card images
Briefs and detailed reports Summaries
The profile summaries block / configuring the endpoint Config reference, LLM endpoints
Diagnosing a slow or empty report Summaries > Diagnostics
Demo and evaluation Evaluation tools
Story Q&A Story Q&A
Keyword alerts Alerts
Public API (v1) API reference
Authentication (NAS / exposed port) Authentication and admin keys
Development Architecture, Testing
Configuration profiles.yaml, Environment variables, Config reference
(new) First-run checklist, NAS / home server, CLI index, Backups, Troubleshooting, Glossary, Database tables