|
1 | 1 | # Delphi Documentation Directory |
2 | 2 |
|
3 | | -This document provides an overview of key documentation files in the Delphi system, organized by topic for easy reference. |
| 3 | +Index of the documentation in `delphi/docs/`, organized by topic. |
4 | 4 |
|
5 | | -## Core System Documentation |
| 5 | +> **Last cleaned: 2026-06-11.** 33 stale leftover docs (completed fix memos, session |
| 6 | +> logs, unimplemented design proposals, docs describing deleted architecture) were |
| 7 | +> moved to [archive/](archive/) — kept as raw material capturing the original design |
| 8 | +> intent of the 2025 build-out, but **not documentation of the current system** (see |
| 9 | +> [archive/CLAUDE.md](archive/CLAUDE.md) for the per-file index). Surviving docs were |
| 10 | +> spot-checked against the code on that date; still, when a doc and the code disagree, |
| 11 | +> trust the code. |
6 | 12 |
|
7 | | -| Document | Description | |
8 | | -|----------|-------------| |
9 | | -| [CLAUDE.md](../CLAUDE.md) | Main reference guide with configuration details, database interactions, and system operation | |
10 | | -| [README.md](../README.md) | Project overview and basic setup instructions | |
11 | | -| [QUICK_START.md](QUICK_START.md) | Get started quickly with the Delphi system | |
12 | | -| [RUNNING_THE_SYSTEM.md](RUNNING_THE_SYSTEM.md) | Step-by-step instructions for operating the Delphi system | |
13 | | -| [architecture_overview.md](architecture_overview.md) | High-level overview of the system architecture | |
14 | | -| [project_structure.md](project_structure.md) | Explanation of the project's directory and file organization | |
15 | | - |
16 | | -## Database and Data Format Documentation |
| 13 | +## Canonical / living documents |
17 | 14 |
|
18 | 15 | | Document | Description | |
19 | 16 | |----------|-------------| |
20 | | -| [DATABASE_NAMING_PROPOSAL.md](DATABASE_NAMING_PROPOSAL.md) | Explanation of table naming conventions and migration plan | |
21 | | -| [DATA_FORMAT_STANDARDS.md](DATA_FORMAT_STANDARDS.md) | **Critical standards for data formats throughout the system, including DynamoDB key formats** | |
22 | | -| [JOB_QUEUE_SCHEMA.md](JOB_QUEUE_SCHEMA.md) | Schema documentation for the job queue system | |
23 | | -| [S3_STORAGE.md](S3_STORAGE.md) | Information about S3 storage configuration and access | |
| 17 | +| [PLAN_DISCREPANCY_FIXES.md](PLAN_DISCREPANCY_FIXES.md) | **Canonical plan** for the Clojure-parity fix campaign (D-fixes), statuses, ordering | |
| 18 | +| [CLJ-PARITY-FIXES-JOURNAL.md](CLJ-PARITY-FIXES-JOURNAL.md) | **Append-only session journal** of the parity work — findings, decisions, test results | |
| 19 | +| [deep-analysis-for-julien/](deep-analysis-for-julien/) | Deep Clojure-vs-Python analysis (architecture, PCA, clustering, repness, routing, discrepancy catalog). Historical reference; see status note in `07-discrepancies.md` | |
24 | 20 |
|
25 | | -## Job System Documentation |
| 21 | +## Getting started & operations |
26 | 22 |
|
27 | 23 | | Document | Description | |
28 | 24 | |----------|-------------| |
29 | | -| [JOB_SYSTEM_DESIGN.md](JOB_SYSTEM_DESIGN.md) | Overall job system architecture and design principles | |
30 | | -| [JOB_STATE_MACHINE_DESIGN.md](JOB_STATE_MACHINE_DESIGN.md) | **Detailed explanation of the job state machine and workflow design** | |
31 | | -| [DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md](DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md) | **Comprehensive guide to troubleshooting common job system issues** | |
32 | | -| [JOB_ID_MIGRATION_PLAN.md](JOB_ID_MIGRATION_PLAN.md) | Plan for migrating to the new job ID system | |
33 | | - |
34 | | -## API Integration Documentation |
| 25 | +| [QUICK_START.md](QUICK_START.md) | Environment setup (uv/.venv) and standard test invocation | |
| 26 | +| [RUNNING_THE_SYSTEM.md](RUNNING_THE_SYSTEM.md) | Operating the pipeline: run_delphi, CLI, job submission | |
| 27 | +| [DELPHI_DOCKER.md](DELPHI_DOCKER.md) | Delphi container overview | |
| 28 | +| [DOCKER_BUILD_OPTIMIZATION.md](DOCKER_BUILD_OPTIMIZATION.md) | Layered Docker builds, requirements.lock workflow | |
| 29 | +| [DELPHI_AUTOSCALING_SETUP.md](DELPHI_AUTOSCALING_SETUP.md) | Instance-size based worker configuration (`configure_instance.py`, `INSTANCE_SIZE`) | |
| 30 | +| [RESET_SINGLE_CONVERSATION.md](RESET_SINGLE_CONVERSATION.md) | Removing all Delphi data for one conversation | |
| 31 | +| [S3_STORAGE.md](S3_STORAGE.md) | S3/MinIO storage for visualizations | |
| 32 | +| [OLLAMA_MODEL_CONFIG.md](OLLAMA_MODEL_CONFIG.md) | Ollama model configuration for topic naming | |
| 33 | +| [CLI_STATUS_COMMAND.md](CLI_STATUS_COMMAND.md) | `./delphi status <zid>` CLI command | |
| 34 | + |
| 35 | +## Job system |
35 | 36 |
|
36 | 37 | | Document | Description | |
37 | 38 | |----------|-------------| |
38 | | -| [ANTHROPIC_BATCH_API_GUIDE.md](ANTHROPIC_BATCH_API_GUIDE.md) | **Complete guide for working with Anthropic's Batch API, including common issues and solutions** | |
39 | | -| [OLLAMA_MODEL_CONFIG.md](OLLAMA_MODEL_CONFIG.md) | Configuration guide for Ollama models | |
40 | | -| [CLI_STATUS_COMMAND.md](CLI_STATUS_COMMAND.md) | Documentation for the CLI status command | |
| 39 | +| [JOB_STATE_MACHINE_DESIGN.md](JOB_STATE_MACHINE_DESIGN.md) | Job types (FULL_PIPELINE, CREATE_NARRATIVE_BATCH, AWAITING_NARRATIVE_BATCH) and transitions | |
| 40 | +| [JOB_QUEUE_SCHEMA.md](JOB_QUEUE_SCHEMA.md) | `Delphi_JobQueue` schema, GSIs, locking patterns | |
| 41 | +| [DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md](DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md) | Diagnosing stuck jobs, DynamoDB gotchas, log locations | |
| 42 | +| [DATA_FORMAT_STANDARDS.md](DATA_FORMAT_STANDARDS.md) | DynamoDB key formats (`#` delimiters), reserved keywords, type conversions | |
41 | 43 |
|
42 | | -## Deployment and Infrastructure |
| 44 | +## Math & Clojure parity reference |
43 | 45 |
|
44 | 46 | | Document | Description | |
45 | 47 | |----------|-------------| |
46 | | -| [DELPHI_AUTOSCALING_SETUP.md](DELPHI_AUTOSCALING_SETUP.md) | Configuration for auto-scaling the system | |
47 | | -| [DISTRIBUTED_SYSTEM_ROADMAP.md](DISTRIBUTED_SYSTEM_ROADMAP.md) | Roadmap for distributed system improvements | |
| 48 | +| [CLOJURE_COMPARISON.md](CLOJURE_COMPARISON.md) | Clojure-vs-Python comparison test infrastructure and known differences | |
| 49 | +| [CLOJURE_TWO_LEVEL_CLUSTERING.md](CLOJURE_TWO_LEVEL_CLUSTERING.md) | Two-level (base→group) clustering architecture, as implemented | |
| 50 | +| [SUBGROUP_CLUSTERING_THIRD_LEVEL.md](SUBGROUP_CLUSTERING_THIRD_LEVEL.md) | Clojure's third clustering level (subgroups) — unported, unused by consumers | |
| 51 | +| [regression_testing.md](regression_testing.md) | Golden-snapshot regression testing: recorder, comparer, datasets | |
| 52 | +| [INVESTIGATION_K_DIVERGENCE.md](INVESTIGATION_K_DIVERGENCE.md) | K-means k divergence investigation (RESOLVED — kept as record) | |
| 53 | +| [SESSION_HANDOFF_KMEANS.md](SESSION_HANDOFF_KMEANS.md) | K-means parity session background (partially historical — see status note) | |
| 54 | +| [HANDOFF_PR14_VECTORIZED_REFACTOR.md](HANDOFF_PR14_VECTORIZED_REFACTOR.md) | Repness refactor handoff (14a in open stack; 14b/14c open) | |
| 55 | +| [HANDOFF_REGRESSION_TEST_PERF.md](HANDOFF_REGRESSION_TEST_PERF.md) | Regression-test performance (mostly resolved — see status note) | |
48 | 56 |
|
49 | | -## Algorithm and Analysis Documentation |
| 57 | +## Topic pipeline (umap_narrative) |
50 | 58 |
|
51 | 59 | | Document | Description | |
52 | 60 | |----------|-------------| |
53 | | -| [algorithm_analysis.md](algorithm_analysis.md) | Analysis of the core algorithms used in Delphi | |
54 | | -| [TOPIC_NAMING.md](TOPIC_NAMING.md) | Topic naming pipeline: exact prompt, deterministic 5‑comment sampling, logging, storage | |
55 | | -| [usage_examples.md](usage_examples.md) | Examples of system usage and output interpretations | |
| 61 | +| [TOPIC_NAMING.md](TOPIC_NAMING.md) | Topic naming: prompt, sampling, storage in `Delphi_CommentClustersLLMTopicNames` | |
| 62 | +| [topic-moderation-system.md](topic-moderation-system.md) | Topic moderation endpoints and `Delphi_TopicModerationStatus` | |
| 63 | +| [TOPIC_AGENDA_STORAGE_DESIGN.md](TOPIC_AGENDA_STORAGE_DESIGN.md) | Topic agenda storage (`topic_agenda_selections`); Phase 3 never implemented | |
| 64 | +| [VERSIONED_TOPIC_KEYS_IMPLEMENTATION.md](VERSIONED_TOPIC_KEYS_IMPLEMENTATION.md) | Versioned topic/section keys (`report_id#section#model`) | |
56 | 65 |
|
57 | | -## Testing and Development |
| 66 | +## Open issues & audits (still unresolved — do not delete until fixed) |
58 | 67 |
|
59 | 68 | | Document | Description | |
60 | 69 | |----------|-------------| |
61 | | -| [SIMPLIFIED_TESTS.md](SIMPLIFIED_TESTS.md) | Simplified testing procedures | |
62 | | -| [TESTING_LOG.md](TESTING_LOG.md) | Log of testing activities and results | |
63 | | -| [TEST_RESULTS_SUMMARY.md](TEST_RESULTS_SUMMARY.md) | Summary of test results | |
64 | | - |
65 | | -## Recently Added Documentation |
66 | | - |
67 | | -The following documentation was recently added to address specific system challenges: |
68 | | - |
69 | | -1. **[ANTHROPIC_BATCH_API_GUIDE.md](ANTHROPIC_BATCH_API_GUIDE.md)** - Comprehensive guide for working with Anthropic's Batch API in the Delphi system, including: |
70 | | - - Handling JSON Lines (JSONL) responses from the API |
71 | | - - Proper error handling for API interactions |
72 | | - - Key format requirements for storing results in DynamoDB |
73 | | - - Debugging strategies for batch processing issues |
74 | | - |
75 | | -2. **[DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md](DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md)** - Detailed guide for troubleshooting job system issues, including: |
76 | | - - Strategies for diagnosing stuck jobs |
77 | | - - Solutions for common DynamoDB reserved keyword issues |
78 | | - - Techniques for tracing end-to-end job execution |
79 | | - - Database verification processes |
80 | | - |
81 | | -3. **[DATA_FORMAT_STANDARDS.md](DATA_FORMAT_STANDARDS.md)** - Critical standards document focusing on: |
82 | | - - Required format for DynamoDB keys (using # as delimiters) |
83 | | - - JSON structure standards for reports |
84 | | - - Handling of reserved keywords in DynamoDB |
85 | | - - Conversion between PostgreSQL and DynamoDB data types |
86 | | - |
87 | | -4. **[JOB_STATE_MACHINE_DESIGN.md](JOB_STATE_MACHINE_DESIGN.md)** - Documentation of the state machine design for job processing: |
88 | | - - Explicit job types for different processing stages |
89 | | - - Clear script mapping between job types and processing scripts |
90 | | - - Clean state transition patterns |
91 | | - - Error handling best practices |
| 70 | +| [ZID_EXPOSURE_AUDIT.md](ZID_EXPOSURE_AUDIT.md) | **Open security issue**: zid/conversation_id exposed in delphi API responses | |
| 71 | +| TOPIC_LABEL_MISALIGNMENT_ANALYSIS.md | **Open bug**: label/cluster sorting misalignment in `700_datamapplot_for_layer.py` (local-only file, in `.git/info/exclude` — not present on fresh clones) | |
0 commit comments