fix(presentation): trim README + add OVERVIEW.md code index#144
Merged
Conversation
…ndex Follow-up to the merged PR #142 (verbose 154-line README). Per the canonical-template revisit landing in alpha-engine-docs PR #20, the locked README target is ~60 lines and detail pushes to OVERVIEW.md. README changes (154 → 68 lines): - Drop Quick start, Key files, How it runs, S3 contract, Testing → all push to OVERVIEW.md - Drop env-var enumeration → push to OVERVIEW.md - Compress Configuration to 1-2 sentences naming the disclosure boundary, no file index - Switch ASCII architecture diagram to mermaid (4-flow high-level picture: Phase 1 / RAG / Phase 2 / EOD → ArcticDB / pgvector / S3 staging) - Drop ASCII detail block (constituents/prices/slim_cache/macro/ universe_returns/feature_store enumeration) — that's an OVERVIEW concern, not a README concern - Drop verbose Quality Gates + Design Rationale prose (compressed to a one-line note under the diagram) Path corrections: - Prior README claimed `feature_store/compute.py` — that path doesn't exist (actual: `features/feature_engineer.py`). All file references in OVERVIEW.md verified against the filesystem before committing. OVERVIEW.md (new, 79 lines): - 7 sections per locked template (alpha-engine-docs PR #20): Module purpose, Entry points (4 files), Where things live (~20 concept→file mappings), Inputs/outputs (S3 contract), Run modes, Tests (one paragraph) - All file paths verified against the actual filesystem This is the first prototype OVERVIEW.md. Same shape will apply to the other 5 module repos in upcoming PRs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 3, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Follow-up to merged PR #142. Per the canonical-template revisit (alpha-engine-docs PR #20), the locked README target is ~60 lines bird's-eye and detail pushes to a companion OVERVIEW.md code index.
Changes
README (154 → 68 lines): drops Quick start, Key files, How it runs, S3 contract, Testing, env-var enumeration, full ASCII architecture detail, and verbose design-rationale prose. Compresses Configuration to a one-paragraph disclosure boundary. ASCII diagram → 4-flow mermaid (Phase 1 · RAG · Phase 2 · EOD → ArcticDB / pgvector / S3 staging).
OVERVIEW.md (new, 79 lines): 7-section index per the locked template — Module purpose · Entry points (4 files) · Where things live (~20 concept→file mappings) · Inputs/outputs (S3 contract) · Run modes (6 rows) · Tests (one paragraph).
Path correction
Prior README referenced
feature_store/compute.py— that path doesn't exist (actual:features/feature_engineer.py). All file paths in OVERVIEW.md verified against the filesystem before committing.Companion
Test plan
🤖 Generated with Claude Code