Draft version of design agreements summary - #67
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a draft top-level design-agreements summary for Phlex, collecting agreement-like decisions from related GitHub issues and organization discussions and organizing them by subsystem.
Changes:
- Adds a new Markdown document summarizing design agreements, caveats, and tensions.
- Cross-references relevant Phlex subsystem design documentation and source issue/discussion threads.
- Identifies unsettled contradictions around product-query semantics and hierarchy/layer knowledge.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@marcpaterno, I made some changed with commit e06cd86 (just removing unnecessary content, and renumbering lists accordingly) |
Rename the supporting-design chapter directory from ch_subsystem_design to ch_technical_design to align the documentation with technical-design terminology. Update toctrees, Sphinx exclude patterns, and cross-references from conceptual design and appendix requirements so the moved chapter and its sections continue to resolve correctly.
This completes the set of agreements to be imported to the technical design document.
knoepfel
left a comment
knoepfel
left a comment
There was a problem hiding this comment.
@marcpaterno and @sabasehrish, thanks for the PR. Some specific suggestions below.
Co-authored-by: Kyle Knoepfel <knoepfel@fnal.gov>
|
Important Review skippedIgnore keyword(s) in the title. ⛔ Ignored keywords (4)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This adds a "design agreements summary", collected from Github issues and Github discussions.