Improve design documentation#102
Merged
gab-arrobo merged 2 commits intoomec-project:mainfrom Jan 30, 2026
Merged
Conversation
Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the design documentation by enhancing clarity, structure, and accessibility of the SMF and MetricFunc documentation files.
Changes:
- Added accessibility improvement with alt text for the SMF architecture diagram
- Restructured UPF-Adapter documentation with clearer formatting and improved readability
- Added proper syntax highlighting to code blocks in the MetricFunc documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| design/design-smf.rst | Enhanced SMF documentation with alt text for diagram and improved UPF-Adapter section structure |
| design/design-metricfunc.rst | Added appropriate language identifiers to code blocks for better syntax highlighting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sureshmarikkannu
previously approved these changes
Jan 30, 2026
Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
sureshmarikkannu
approved these changes
Jan 30, 2026
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
2 participants
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.
No description provided.