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

Add information to docs showing overview of how Surfactant works #321

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

nightlark
Copy link
Collaborator

@nightlark nightlark commented Jan 14, 2025

Adds diagrams and some description of how Surfactant works, at a high-level and showing some internal details on the plugin architecture and when different hooks a plugin could implement get called.

Resolves #77

@nightlark nightlark added the documentation Improvements or additions to documentation label Jan 14, 2025
nightlark added a commit that referenced this pull request Jan 14, 2025
Add diagram showing high-level overview of Surfactant, and a lower-level
diagram with more detail on how some commonly used hooks in the plugin
system fit into the way that Surfactant generates SBOMs.

Resolves #77
@nightlark nightlark force-pushed the add-diagrams-to-docs branch from 7cc018f to 79615ec Compare January 14, 2025 00:53
nightlark added a commit that referenced this pull request Jan 14, 2025
Add diagram showing high-level overview of Surfactant, and a lower-level
diagram with more detail on how some commonly used hooks in the plugin
system fit into the way that Surfactant generates SBOMs.

Resolves #77
@nightlark nightlark force-pushed the add-diagrams-to-docs branch from 5ba272d to 96506e0 Compare January 14, 2025 00:55
@nightlark nightlark changed the title Add information and diagrams showing how Surfactant works Add information to docs showing overview of how Surfactant works Jan 14, 2025
@nightlark nightlark force-pushed the add-diagrams-to-docs branch from 69aa926 to 9ea20a7 Compare January 14, 2025 00:57
nightlark added a commit that referenced this pull request Jan 14, 2025
Add diagram showing high-level overview of Surfactant, and a lower-level
diagram with more detail on how some commonly used hooks in the plugin
system fit into the way that Surfactant generates SBOMs.

Resolves #77
Add diagram showing high-level overview of Surfactant, and a lower-level
diagram with more detail on how some commonly used hooks in the plugin
system fit into the way that Surfactant generates SBOMs.

Resolves #77
@nightlark nightlark force-pushed the add-diagrams-to-docs branch from 9ea20a7 to fc8684d Compare January 14, 2025 00:57
@nightlark nightlark merged commit fc8684d into main Jan 14, 2025
14 checks passed
@nightlark nightlark deleted the add-diagrams-to-docs branch January 14, 2025 01:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create diagrams showing how Surfactant works
1 participant