Feat/presentation readme rewrite#145
Closed
cipher813 wants to merge 3 commits into
Closed
Conversation
Phase 1 Day 3 of the presentation revamp arc — alpha-engine-data is the prototype per-module README. Other 5 modules + lib follow this shape. Applied: - Brand banner (canonical wording from alpha-engine-docs/branding/) - 6 badges per the standard bar (brand, python, ArcticDB, polygon, MIT, Phase 2) - Pointer to alpha-engine-docs as the system-overview home — module README does NOT duplicate the full system architecture, all-6- modules table, Phase trajectory, or Step Function pipelines (per the zones-of-responsibility matrix in templates/README_TEMPLATE.md) - New "Phase 2 measurement contribution" paragraph naming this module's role in the measurement substrate (data is what everything else measures against) - Architecture diagram now module-internal: external APIs → Phase 1 / Phase 2 / EOD flows + storage targets. Drops the prior diagram's full-Step-Function rendering (system-level content). - Three-pipeline accuracy: Phase 1 (Sat EC2 SSM) + Phase 2 (Sat Lambda) + EOD (Mon-Fri ae-trading) — matches the corrected SF topology in alpha-engine-docs README - Sister-repos table is now links-only (no role descriptions repeated — those live in alpha-engine-docs) - Includes alpha-engine-lib as a sister repo (reflecting the recent public flip) Net: 220 lines → 143 lines (−77). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The original rewrite (commit 755425d) missed the RAG ingestion step that data owns. RAGIngestion runs between DataPhase1 and Research as its own SF state, and the rag/ folder in this repo holds the ingestion pipelines + preflight (canonical retrieval/serving lives in alpha-engine-research/rag/). Five additions: 1. New "What this does" bullet covering RAG ingestion (SEC 10-K/10-Q /8-K, earnings transcripts, thesis history → Voyage embeddings → Neon pgvector) 2. RAG section added to the architecture diagram between Phase 1 and Phase 2 3. New row in "How it runs" table for RAG ingestion 4. New row in S3 contract Writes table for the Neon pgvector tables 5. New Key Files entry pointing at rag/pipelines/ Also restored the "## What this does" header that was accidentally dropped in the prior edit. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Per the canonical-template revisit (alpha-engine-docs PR #20). Locked three-tier surface separation: - README (~60 lines, public): What is this module - OVERVIEW.md (~80 lines, public): Where is the code - private/interview_kit/ (private): How does it work + what to say This commit applies the lean shape to data and adds the first prototype 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 (or skip) - 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 - Sister repos table now includes alpha-engine-lib (recently public) - Drop Tests section (now in OVERVIEW.md) Architecture-diagram correctness: - Prior README claimed "feature_store/compute.py" — that path doesn't exist (actual: features/feature_engineer.py) - Prior README claimed "trading_calendar.py" at top — that's now in alpha-engine-lib (per the lib v0.3.0 + Stage 3 RAG migration arc) - Prior README claimed "health_checker.py" — that's not in this repo (may have been removed or renamed) - All file references in OVERVIEW.md verified against the actual filesystem before committing — no fabricated paths 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 (6 rows), 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 6 module repos in the upcoming Phase 1 Days 5-9. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
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.
No description provided.