docs: reorganize docs/ into design_docs/, developer_docs/, and user-guide/ - #265
Merged
Merged
Conversation
…uide/ design_docs/ (conceptual/design rationale, not how-to): asap_aware_mapping.md, cse-cost-model-decision.md, parse_and_canonicalize.md, post-asap-ir.md, pre-asap-ir.md user-guide/: user-guide.md developer_docs/ is created by PR #259 (ASAP-aware-mapping-developer-guide.md lands there directly; not on main yet). Updated every cross-reference to a moved path: README.md's doc links, docs/user-guide/user-guide.md's internal references, and the rustdoc comments in bind.rs/cost_model.rs/cse.rs that cite docs/cse-cost-model-decision.md or docs/pre-asap-ir.md. cargo check --workspace passes clean (comment-only changes in Rust source).
zzylol
added a commit
that referenced
this pull request
Aug 24, 2026
…'s current tip #263 (feat/cascades-search-252) was just rewritten (force-pushed) as part of syncing every #33 sub-issue PR to #259's current tip. This branch, stacked on #263, was still built on #263's old (pre-rewrite) history, which made the two branches diverge and GitHub start reporting this PR CONFLICTING against its base. Rebuilt fresh: reset onto #263's current tip, then reapplied applicability.rs (already updated per this PR's own review-comment fixes: "site" -> TargetSubDAG throughout, stale boundary:: doc links fixed) verbatim, since it depends only on crate::search/crate::replacement, both stable and unchanged in shape across the rewrite. Wired it into lib.rs (pub mod applicability;, its Status bullet, and its exports), and picked up two small search.rs doc improvements this PR had made (replacing "a hypothetical applicability::..." with real references, now that this module exists) that were otherwise lost. The design doc's old "## Applicability reporting" section this PR originally added lived at docs/asap_aware_mapping.md, a path deleted by the docs reorg (#265) that landed on main in the meantime; the design doc's current location (docs/design_docs/asap_aware_mapping.md) already carries its own "# Applicability Reporting" section, written independently and already consistent with this PR's own terminology fix (uses "Target Sub-DAG" throughout, no "site"). Left it untouched rather than reintroducing now-orphaned content. Verified: cargo build --workspace --all-targets, cargo test --workspace (0 failures, including all 11 applicability:: tests), cargo fmt --all -- --check, cargo clippy --workspace --all-targets --all-features -- -D warnings — all clean. Co-Authored-By: Claude Sonnet 5 <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.
What
Groups
docs/into three folders by audience instead of one flat list:docs/design_docs/— conceptual/design rationale, not how-to:asap_aware_mapping.md,cse-cost-model-decision.md,parse_and_canonicalize.md,post-asap-ir.md,pre-asap-ir.mddocs/user-guide/—user-guide.mddocs/developer_docs/— lands from feat(asap-aware-mapping): generalize summary/CSE selection into a ReplacementStrategy trait #259 (ASAP-aware-mapping-developer-guide.md), not part of this PR since that file doesn't exist onmainyetCross-references updated
README.md's 6 doc linksdocs/user-guide/user-guide.md's internal references to the other moved docscrates/asap-aware-mapping/src/bind.rs,crates/asap-aware-mapping/src/cost_model.rs, andcrates/types/src/pre_asap/cse.rsthat citedocs/cse-cost-model-decision.mdordocs/pre-asap-ir.mdNo content changes — pure moves plus path fixups.
cargo check --workspacepasses clean.Coordination with #259
#259 (still open) moves
ASAP-aware-mapping-developer-guide.mdintodocs/developer_docs/on its own branch and links it to this PR'sdocs/design_docs/asap_aware_mapping.mdpath — that link only resolves once both are merged.🤖 Generated with Claude Code