Skip to content

Conversation

@halcwb
Copy link
Collaborator

@halcwb halcwb commented Dec 9, 2025

This pull request primarily updates documentation to improve clarity, accuracy, and traceability for both developers and regulatory compliance. The most significant changes include correcting naming conventions for projects and libraries, updating architecture and communication pattern descriptions, adding references to canonical documentation for commit messages and scopes, and introducing a comprehensive index to the MDR documentation folder.

Documentation improvements and corrections:

  • Updated project and library names in WARP.md to use consistent, uppercase naming conventions (e.g., GenORDER, GenSOLVER, GenUNITS, GenFORM) and corrected references throughout architecture and library descriptions. [1] [2] [3]
  • Revised architecture section in WARP.md to reflect updated source directory structure for server, client, and shared components, and clarified the location of API contracts. [1] [2]
  • Added references in WARP.md to canonical documentation for commit message instructions and supported scopes, improving traceability and consistency for contributors. [1] [2]
  • Introduced an index in docs/mdr/README.md to organize MDR compliance documentation, making it easier to navigate design history, requirements, risk analysis, usability, post-market surveillance, validation, interfaces, and regulations overview.

@halcwb halcwb merged commit 2837c9f 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