Enhance llm.md: architecture, error propagation, caching, and completeness - #138
Merged
Conversation
… improvements Multi-perspective review of llm.md identified gaps in pipeline stage documentation, error architecture, caching boundaries, and file/type inventory. Adds new sections for conditional masking mechanics, error propagation paths, chain disqualification, display class prediction invariants, and subquery/aggregate support. Completes file map with 19 previously undocumented files and expands Models inventory to 27 types.
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
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
Comprehensive enhancement of
src/Quarry.Generator/llm.mdbased on multi-perspective code review (architecture/data flow, debugging/troubleshooting, invariants/edge cases, file map completeness). 173 insertions, 15 deletions.Reason for Change
The existing llm.md had significant gaps that would hinder maintainers and LLMs working on the generator:
.Collect()barriers, post-analysis transforms (result type patching, site propagation), and the 3a/3b Bind/Translate split were invisibleImpact
Documentation-only change. No code modifications.
Plan items implemented as specified
Deviations from plan implemented
Gaps in original plan implemented
Migration Steps
N/A — documentation only.
Performance Considerations
N/A — documentation only.
Security Considerations
N/A — documentation only.
Breaking Changes