Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add repository map reference to README.md #235

Merged
merged 1 commit into from
Oct 4, 2023

Conversation

alexkarezin
Copy link
Contributor

Description

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/samsunglpvs/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project. In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.

Type of change

  • Documentation update

How Has This Been Tested?

No functionality impact. Documentation-only changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/samsunglpvs/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project. In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.
@o-kopysov
Copy link
Collaborator

@alexkarezin On the page "Module Dependencies" I see the error log
https://sourcespy.com/github/samsunglpvs/xx-mdependencies-.html
Do you know how we can fix this issue?

@alexkarezin
Copy link
Contributor Author

@o-kopysov ...that's quite embarrassing (my oversight). I'll make sure to have this addressed today.

@alexkarezin
Copy link
Contributor Author

The page was pointing to a module diagram without module context. The issue has been addressed. Thank you for your consideration!

Copy link
Member

@tiokim tiokim left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Collaborator

@MoonkiHong MoonkiHong left a comment

Choose a reason for hiding this comment

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

+1

Copy link
Collaborator

@o-kopysov o-kopysov left a comment

Choose a reason for hiding this comment

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

+1

@o-kopysov o-kopysov merged commit 8fd74f2 into Samsung:main Oct 4, 2023
5 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.

4 participants