docs: reconcile design.md + README with the landed crate layout - #63
Merged
Conversation
…follow-up) Follow-up to the crate reorg (#57): make the design doc and README accurately distinguish what's landed from what's still planned. docs/design.md: - Status banner up top: this is the target design; §5.1 is what exists. - §5 split into "5.1 Landed layout" (crate DAG + real tree + parser-quarantine note) and "5.2 Target layout (planned)". - New §6.0 mapping table: the `core::<module>` names used throughout §6 → the crates that ship them today (asap-ir / asap-sketch / asap-plan / asap-frontend-*). - Fixed stale identifiers in planned-feature snippets: asap-control-core -> asap-ir, asap-control-optimizer -> asap-plan, core::optimizer -> asap-plan, and the P1 principle + §11 workspace-members example. - Glossary "IR by layer" crate names updated. README.md: - Marked the deployment-model / HTTP-service / CLI consumption modes as planned (only the Rust-library mode is available today). Docs only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Follow-up to the crate reorg (#57): make
docs/design.mdandREADME.mdaccurately distinguish landed from planned.docs/design.md
crates/tree + the parser-quarantine rationale) and "5.2 Target layout (planned)".core::<module>names used throughout §6 → the crates that ship them today (asap-ir/asap-sketch/asap-plan/asap-frontend-*), with status.asap-control-core→asap-ir,asap-control-optimizer→asap-plan,core::optimizer→asap-plan), the P1 principle, the §11 workspace-members example, and the glossary.README.md
Docs only; no code touched.
🤖 Generated with Claude Code