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

doc: First stab at an archiecture overview #4530

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

lgritz
Copy link
Collaborator

@lgritz lgritz commented Nov 9, 2024

Having such a document is one of the remaining steps to getting our OpenSSF Best Practices silver level badge.

Having such a document is ane of the remaining steps to getting
our OpenSSF Best Practices silver level badge.

Signed-off-by: Larry Gritz <lg@larrygritz.com>
@lgritz lgritz added docs Documentation admin Project administration, process, policy labels Nov 13, 2024
Signed-off-by: Larry Gritz <lg@larrygritz.com>
@lgritz
Copy link
Collaborator Author

lgritz commented Nov 15, 2024

This has been posted for a week. Any comments?

If you look in the "files changed" tab, then click the icon that looks like a piece of paper with a folded corner, whose pop-up help text is "display the rich text", then it will show you the rendered markdown, including the class block diagram I made.

Seeking feedback on whether this is an ok stab at a high-level whitepaper on the overall architecture of the project and its pieces.

Signed-off-by: Larry Gritz <lg@larrygritz.com>
@lgritz lgritz requested a review from grdanny November 18, 2024 19:24
Copy link
Contributor

@mugulmd mugulmd left a comment

Choose a reason for hiding this comment

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

From a developer perspective with little experience on the project, I can honestly say that this is gold !
Clear and concise, I didn't spot any typo or anything, so LGTM :)

@lgritz lgritz merged commit b94b10a into AcademySoftwareFoundation:main Nov 21, 2024
3 checks passed
@lgritz lgritz deleted the lg-architecture branch November 21, 2024 18:56
lgritz added a commit to lgritz/OpenImageIO that referenced this pull request Nov 21, 2024
…#4530)

Having such a document is one of the remaining steps to getting our
OpenSSF Best Practices silver level badge.

---------

Signed-off-by: Larry Gritz <lg@larrygritz.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin Project administration, process, policy docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants