Skip to content

Conversation

@halcwb
Copy link
Collaborator

@halcwb halcwb commented Dec 9, 2025

This pull request updates and significantly expands the project documentation for GenPRES, focusing on clarifying the technical stack, directory structure, architectural design, and the relationships between core domain libraries. The changes improve accuracy, add references to detailed specifications, and make the documentation more approachable for both new and experienced contributors.

Key documentation improvements:

General updates and corrections:

  • Updated the required .NET SDK version from 9.0.0 to 10.0.0 throughout the documentation to reflect the current technology stack. [1] [2]
  • Clarified and reorganized the directory structure in DEVELOPMENT.md, adding missing libraries, correcting descriptions, and grouping related modules more logically. [1] [2]
  • Improved the documentation files section to reference new and reorganized architecture and domain model documents.

Architecture and domain model documentation:

  • Added direct links and summaries for comprehensive architectural documentation, including the technical stack, core domain model, transformation pipeline, and the function of major libraries. [1] [2]
  • Rewrote and expanded the architecture overview in docs/mdr/design-history/architecture.md to clarify the transformation pipeline (Free Text → OKRs → Order Scenarios → Quantitative Solutions), domain concepts, and the role of constraint-based calculation.
  • Replaced and improved explanations of the order model, calculation variables, and equations with references to detailed specifications in the domain documentation.

File and library references:

  • Updated references to entry points, API implementation files, and configuration files to reflect new file locations and naming conventions. [1] [2] [3]
  • Added a new section summarizing key domain libraries and where to find their specifications.

Reference and navigation improvements:

  • Added and updated links to the technical stack, domain model, and library specifications for easier navigation and onboarding.

These changes collectively make the documentation more accurate, navigable, and useful for developers working on or onboarding to the GenPRES project.


Most important changes by theme:

1. Technology stack and directory structure

  • Updated .NET SDK requirement to 10.0.0 and revised file references and descriptions throughout the documentation to match the current project structure and file locations. [1] [2] [3]
  • Refined the directory and library listings in DEVELOPMENT.md, adding missing modules, correcting names, and clarifying the purpose of each library. [1] [2]

2. Architecture and domain model documentation

  • Added direct links and summaries to new and reorganized architectural and domain model documentation, including the transformation pipeline and the relationships between core libraries. [1] [2]
  • Rewrote sections in architecture.md to clarify the transformation from free text to executable orders, and referenced detailed specifications for rules, order models, and constraint solving.

3. Documentation navigation and references

  • Improved documentation navigation by updating the documentation files section, adding references to new architecture and domain documents, and providing a new summary of key files and libraries. [1] [2]
  • Added and updated links to technical stack and domain model references for easier onboarding and deeper dives into the architecture.

@halcwb halcwb merged commit 97a25a4 into informedica:master Dec 9, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant