Skip to content

docs: add diagnostic library component to design document#94

Open
lh-sag wants to merge 2 commits intomainfrom
diagnostic-library
Open

docs: add diagnostic library component to design document#94
lh-sag wants to merge 2 commits intomainfrom
diagnostic-library

Conversation

@lh-sag
Copy link
Contributor

@lh-sag lh-sag commented Mar 17, 2026

Summary

  • Added Diagnostic Library as a new component in the high-level design document, describing its role as the framework-agnostic interface
  • Updated high-level diagram (SVG) to reflect the new component

Checklist

  • I have tested my changes locally
  • I have added or updated documentation
  • I have linked related issues or discussions
  • I have added or updated tests

Related

None

Notes for Reviewers

None

@lh-sag
Copy link
Contributor Author

lh-sag commented Mar 17, 2026

Work in progress. Do not merge.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The IPC arrow from the App which contains fault-lib as well as diag-lib (upper left corner) should not overlay with the IPC arrow which originates from Configuration Manager since that might be misleading to readers.


- Diagnostic Library
- Provides a framework agnostic interface for arbitrary apps and components to register and expose SOVD data resources.
- **The Diagnostic Library is the interface between S-CORE and the OpenSOVD project and should be developed in cooperation - see [ADR S-CORE Interface](./adr/001-adr-score-interface.md).**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **The Diagnostic Library is the interface between S-CORE and the OpenSOVD project and should be developed in cooperation - see [ADR S-CORE Interface](./adr/001-adr-score-interface.md).**
- **The Diagnostic Library is also an interface between S-CORE and the OpenSOVD project and should be developed in cooperation - see [ADR S-CORE Interface](./adr/001-adr-score-interface.md).**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But here I would instead state that such API will be mandated by S-CORE. Otherwise, we will just run into conflicts later I fear.

@lh-sag
Copy link
Contributor Author

lh-sag commented Mar 17, 2026

Address PR comments and added example topology to illustrate it better.

@lh-sag lh-sag marked this pull request as ready for review March 23, 2026 12:09
@lh-sag lh-sag requested a review from a team as a code owner March 23, 2026 12:09
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.

2 participants