-
Notifications
You must be signed in to change notification settings - Fork 258
docs(delphi): archive 33 stale leftover docs, fix stale references #2573
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
ececd01
refactor(delphi): delete dead scalar paths in repness.py (PR 14a)
jucor e80d170
fix(delphi): ns includes PASS votes (Clojure parity, pre-D10)
jucor ba9a4ad
feat(delphi): D10 — Clojure-parity rep comment selection (PR 8)
jucor f9b89a2
feat(delphi): D11 — Clojure-parity consensus comment selection (PR 9)
jucor 1cc74be
feat(delphi): D12 — comment priorities (PR 11)
jucor 40b2bf7
feat(delphi): plumb D11 consensus + D12 priorities through to_dict / …
jucor 93ed44f
fix(delphi): address Copilot review on D10-D12 stack (consensus blob …
jucor f0ff18f
fix(delphi): Decimal-convert D11 consensus for DynamoDB write
jucor 9887049
test(delphi): require_dynamodb skips locally, fails loudly in CI
jucor 1e3f643
docs(delphi): archive 33 stale leftover docs, fix stale references
jucor File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,71 @@ | ||
| # Delphi Documentation Directory | ||
|
|
||
| This document provides an overview of key documentation files in the Delphi system, organized by topic for easy reference. | ||
| Index of the documentation in `delphi/docs/`, organized by topic. | ||
|
|
||
| ## Core System Documentation | ||
| > **Last cleaned: 2026-06-11.** 33 stale leftover docs (completed fix memos, session | ||
| > logs, unimplemented design proposals, docs describing deleted architecture) were | ||
| > moved to [archive/](archive/) — kept as raw material capturing the original design | ||
| > intent of the 2025 build-out, but **not documentation of the current system** (see | ||
| > [archive/CLAUDE.md](archive/CLAUDE.md) for the per-file index). Surviving docs were | ||
| > spot-checked against the code on that date; still, when a doc and the code disagree, | ||
| > trust the code. | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [CLAUDE.md](../CLAUDE.md) | Main reference guide with configuration details, database interactions, and system operation | | ||
| | [README.md](../README.md) | Project overview and basic setup instructions | | ||
| | [QUICK_START.md](QUICK_START.md) | Get started quickly with the Delphi system | | ||
| | [RUNNING_THE_SYSTEM.md](RUNNING_THE_SYSTEM.md) | Step-by-step instructions for operating the Delphi system | | ||
| | [architecture_overview.md](architecture_overview.md) | High-level overview of the system architecture | | ||
| | [project_structure.md](project_structure.md) | Explanation of the project's directory and file organization | | ||
|
|
||
| ## Database and Data Format Documentation | ||
| ## Canonical / living documents | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [DATABASE_NAMING_PROPOSAL.md](DATABASE_NAMING_PROPOSAL.md) | Explanation of table naming conventions and migration plan | | ||
| | [DATA_FORMAT_STANDARDS.md](DATA_FORMAT_STANDARDS.md) | **Critical standards for data formats throughout the system, including DynamoDB key formats** | | ||
| | [JOB_QUEUE_SCHEMA.md](JOB_QUEUE_SCHEMA.md) | Schema documentation for the job queue system | | ||
| | [S3_STORAGE.md](S3_STORAGE.md) | Information about S3 storage configuration and access | | ||
| | [PLAN_DISCREPANCY_FIXES.md](PLAN_DISCREPANCY_FIXES.md) | **Canonical plan** for the Clojure-parity fix campaign (D-fixes), statuses, ordering | | ||
| | [CLJ-PARITY-FIXES-JOURNAL.md](CLJ-PARITY-FIXES-JOURNAL.md) | **Append-only session journal** of the parity work — findings, decisions, test results | | ||
| | [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` | | ||
|
|
||
| ## Job System Documentation | ||
| ## Getting started & operations | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [JOB_SYSTEM_DESIGN.md](JOB_SYSTEM_DESIGN.md) | Overall job system architecture and design principles | | ||
| | [JOB_STATE_MACHINE_DESIGN.md](JOB_STATE_MACHINE_DESIGN.md) | **Detailed explanation of the job state machine and workflow design** | | ||
| | [DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md](DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md) | **Comprehensive guide to troubleshooting common job system issues** | | ||
| | [JOB_ID_MIGRATION_PLAN.md](JOB_ID_MIGRATION_PLAN.md) | Plan for migrating to the new job ID system | | ||
|
|
||
| ## API Integration Documentation | ||
| | [QUICK_START.md](QUICK_START.md) | Environment setup (uv/.venv) and standard test invocation | | ||
| | [RUNNING_THE_SYSTEM.md](RUNNING_THE_SYSTEM.md) | Operating the pipeline: run_delphi, CLI, job submission | | ||
| | [DELPHI_DOCKER.md](DELPHI_DOCKER.md) | Delphi container overview | | ||
| | [DOCKER_BUILD_OPTIMIZATION.md](DOCKER_BUILD_OPTIMIZATION.md) | Layered Docker builds, requirements.lock workflow | | ||
| | [DELPHI_AUTOSCALING_SETUP.md](DELPHI_AUTOSCALING_SETUP.md) | Instance-size based worker configuration (`configure_instance.py`, `INSTANCE_SIZE`) | | ||
| | [RESET_SINGLE_CONVERSATION.md](RESET_SINGLE_CONVERSATION.md) | Removing all Delphi data for one conversation | | ||
| | [S3_STORAGE.md](S3_STORAGE.md) | S3/MinIO storage for visualizations | | ||
| | [OLLAMA_MODEL_CONFIG.md](OLLAMA_MODEL_CONFIG.md) | Ollama model configuration for topic naming | | ||
| | [CLI_STATUS_COMMAND.md](CLI_STATUS_COMMAND.md) | `./delphi status <zid>` CLI command | | ||
|
|
||
| ## Job system | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [ANTHROPIC_BATCH_API_GUIDE.md](ANTHROPIC_BATCH_API_GUIDE.md) | **Complete guide for working with Anthropic's Batch API, including common issues and solutions** | | ||
| | [OLLAMA_MODEL_CONFIG.md](OLLAMA_MODEL_CONFIG.md) | Configuration guide for Ollama models | | ||
| | [CLI_STATUS_COMMAND.md](CLI_STATUS_COMMAND.md) | Documentation for the CLI status command | | ||
| | [JOB_STATE_MACHINE_DESIGN.md](JOB_STATE_MACHINE_DESIGN.md) | Job types (FULL_PIPELINE, CREATE_NARRATIVE_BATCH, AWAITING_NARRATIVE_BATCH) and transitions | | ||
| | [JOB_QUEUE_SCHEMA.md](JOB_QUEUE_SCHEMA.md) | `Delphi_JobQueue` schema, GSIs, locking patterns | | ||
| | [DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md](DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md) | Diagnosing stuck jobs, DynamoDB gotchas, log locations | | ||
| | [DATA_FORMAT_STANDARDS.md](DATA_FORMAT_STANDARDS.md) | DynamoDB key formats (`#` delimiters), reserved keywords, type conversions | | ||
|
|
||
| ## Deployment and Infrastructure | ||
| ## Math & Clojure parity reference | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [DELPHI_AUTOSCALING_SETUP.md](DELPHI_AUTOSCALING_SETUP.md) | Configuration for auto-scaling the system | | ||
| | [DISTRIBUTED_SYSTEM_ROADMAP.md](DISTRIBUTED_SYSTEM_ROADMAP.md) | Roadmap for distributed system improvements | | ||
| | [CLOJURE_COMPARISON.md](CLOJURE_COMPARISON.md) | Clojure-vs-Python comparison test infrastructure and known differences | | ||
| | [CLOJURE_TWO_LEVEL_CLUSTERING.md](CLOJURE_TWO_LEVEL_CLUSTERING.md) | Two-level (base→group) clustering architecture, as implemented | | ||
| | [SUBGROUP_CLUSTERING_THIRD_LEVEL.md](SUBGROUP_CLUSTERING_THIRD_LEVEL.md) | Clojure's third clustering level (subgroups) — unported, unused by consumers | | ||
| | [regression_testing.md](regression_testing.md) | Golden-snapshot regression testing: recorder, comparer, datasets | | ||
| | [INVESTIGATION_K_DIVERGENCE.md](INVESTIGATION_K_DIVERGENCE.md) | K-means k divergence investigation (RESOLVED — kept as record) | | ||
| | [SESSION_HANDOFF_KMEANS.md](SESSION_HANDOFF_KMEANS.md) | K-means parity session background (partially historical — see status note) | | ||
| | [HANDOFF_PR14_VECTORIZED_REFACTOR.md](HANDOFF_PR14_VECTORIZED_REFACTOR.md) | Repness refactor handoff (14a in open stack; 14b/14c open) | | ||
| | [HANDOFF_REGRESSION_TEST_PERF.md](HANDOFF_REGRESSION_TEST_PERF.md) | Regression-test performance (mostly resolved — see status note) | | ||
|
|
||
| ## Algorithm and Analysis Documentation | ||
| ## Topic pipeline (umap_narrative) | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [algorithm_analysis.md](algorithm_analysis.md) | Analysis of the core algorithms used in Delphi | | ||
| | [TOPIC_NAMING.md](TOPIC_NAMING.md) | Topic naming pipeline: exact prompt, deterministic 5‑comment sampling, logging, storage | | ||
| | [usage_examples.md](usage_examples.md) | Examples of system usage and output interpretations | | ||
| | [TOPIC_NAMING.md](TOPIC_NAMING.md) | Topic naming: prompt, sampling, storage in `Delphi_CommentClustersLLMTopicNames` | | ||
| | [topic-moderation-system.md](topic-moderation-system.md) | Topic moderation endpoints and `Delphi_TopicModerationStatus` | | ||
| | [TOPIC_AGENDA_STORAGE_DESIGN.md](TOPIC_AGENDA_STORAGE_DESIGN.md) | Topic agenda storage (`topic_agenda_selections`); Phase 3 never implemented | | ||
| | [VERSIONED_TOPIC_KEYS_IMPLEMENTATION.md](VERSIONED_TOPIC_KEYS_IMPLEMENTATION.md) | Versioned topic/section keys (`report_id#section#model`) | | ||
|
|
||
| ## Testing and Development | ||
| ## Open issues & audits (still unresolved — do not delete until fixed) | ||
|
|
||
| | Document | Description | | ||
| |----------|-------------| | ||
| | [SIMPLIFIED_TESTS.md](SIMPLIFIED_TESTS.md) | Simplified testing procedures | | ||
| | [TESTING_LOG.md](TESTING_LOG.md) | Log of testing activities and results | | ||
| | [TEST_RESULTS_SUMMARY.md](TEST_RESULTS_SUMMARY.md) | Summary of test results | | ||
|
|
||
| ## Recently Added Documentation | ||
|
|
||
| The following documentation was recently added to address specific system challenges: | ||
|
|
||
| 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: | ||
| - Handling JSON Lines (JSONL) responses from the API | ||
| - Proper error handling for API interactions | ||
| - Key format requirements for storing results in DynamoDB | ||
| - Debugging strategies for batch processing issues | ||
|
|
||
| 2. **[DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md](DELPHI_JOB_SYSTEM_TROUBLESHOOTING.md)** - Detailed guide for troubleshooting job system issues, including: | ||
| - Strategies for diagnosing stuck jobs | ||
| - Solutions for common DynamoDB reserved keyword issues | ||
| - Techniques for tracing end-to-end job execution | ||
| - Database verification processes | ||
|
|
||
| 3. **[DATA_FORMAT_STANDARDS.md](DATA_FORMAT_STANDARDS.md)** - Critical standards document focusing on: | ||
| - Required format for DynamoDB keys (using # as delimiters) | ||
| - JSON structure standards for reports | ||
| - Handling of reserved keywords in DynamoDB | ||
| - Conversion between PostgreSQL and DynamoDB data types | ||
|
|
||
| 4. **[JOB_STATE_MACHINE_DESIGN.md](JOB_STATE_MACHINE_DESIGN.md)** - Documentation of the state machine design for job processing: | ||
| - Explicit job types for different processing stages | ||
| - Clear script mapping between job types and processing scripts | ||
| - Clean state transition patterns | ||
| - Error handling best practices | ||
| | [ZID_EXPOSURE_AUDIT.md](ZID_EXPOSURE_AUDIT.md) | **Open security issue**: zid/conversation_id exposed in delphi API responses | | ||
| | 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) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.