docs: add real directory structure to README + reconcile migration-plan - #64
Merged
Merged
Conversation
Follow-up to the reorg doc reconciliation (addresses @milind's #57 feedback: "show the new directory structure; the DAG is confusing and fits a lot into asap-ir"). README.md: - Replace the ASCII crate-DAG (ambiguous arrows) with an unambiguous dependency TABLE (crate → role → depends-on → LOC) + the one invariant (everything depends on asap-ir; asap-ir depends on nothing above it). - Add a real file-level `crates/` directory tree that exposes asap-ir's internals (relational / query_expr / agg_intent / lower / binder / schema / …), so it's no longer a black box. - Add a "Why asap-ir holds the most" note: L2 + L3 live together because the L2→L3 converter needs both; modules are separable later if it grows. docs/migration-plan.md: - Status banner: Phases 0–1 landed but split into the layer-named stack, not the single `core` crate; Phases 2–7 pending. - "As landed" notes on Phase 0 (crate set) and Phase 1 (L1–3 shipped as separate crates + a refactored fork; L4/L5 framework not built). - Stale names: asap-control-core -> asap-ir, asap-control-optimizer -> asap-plan. docs/promql-lowering.md: - asap-control-lower -> asap-frontend-promql; crates/core -> crates/ir. Docs only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
5 tasks
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.
Addresses @milindsrivastava1997's feedback on #57 ("show the new directory structure; the DAG is confusing and fits a lot into
asap-ir").README.md
asap-ir;asap-irdepends on nothing above it.crates/tree that exposesasap-ir's internals (relational/query_expr/agg_intent/lower/binder/schema/ …) — so it's no longer a black box.asap-irholds the most" note: L2 + L3 live in one crate because the L2→L3 converter needs both (front ends only emit L2); the modules are cleanly separated and can split later if it grows.docs/migration-plan.md
corecrate) with what shipped (the layer-named split, L1–3 only; L4/L5 framework pending).asap-control-core→asap-ir,asap-control-optimizer→asap-plan.docs/promql-lowering.md
asap-control-lower→asap-frontend-promql;crates/core→crates/ir.Docs only. This is the companion to #63 (which reconciled
design.md+ the README consumption modes).🤖 Generated with Claude Code