Repository map
Find the code, the operating instructions and the original engineering records.
| Area | Start here | What you will find |
|---|---|---|
| Handbook | handbook overview | Fumadocs pages, MDX guides and documentation search. |
| Web app | frontend | Next.js pages, server routes, React components, browser contracts and integration checks. |
| API and schema | backend | FastAPI, SQLAlchemy models, Alembic migrations, ranking, snippets and report services. |
| Discovery and fetching | crawler package | Seed registry, frontier scheduling, fetch policies, parsers, processing and persistence. |
| Index maintenance | indexer package | Freshness selection, weighted vectors, transactional writes, vocabulary and recovery. |
| Deployment | deploy | Compose, Caddy, VM preparation, database maintenance, backups and smoke checks. |
| Developer tools | scripts | Test orchestration, generated indexes, search diagnostics, profiling and benchmark drivers. |
| Test inventory | tests | Cross-project test catalog. Individual suites live beside their packages. |
| Quality and performance | evaluation and reports | Relevance datasets and recorded benchmark outputs. |
| Automation | GitHub workflows | CI, secret scanning and deployment readiness checks. |
| Project visuals | assets | Screenshots of the public interface, dashboard and local development setup. |
Pick a reference by the question you have
- How do I run it? Read the setup guide.
- Why was this design chosen? Browse the decision, incident and experiment index.
- How much did a change cost? Read Core trade-offs, then follow the link to the measurement.
- What happened during development? Open the engineering journal or the technical handoff. Dates matter when reading historical accounts.
- How is this code licensed? The repository includes its MIT license.