docs(ch4): complete Chapter 4 Overview (closes #35) - #44
Draft
Jaydeep869 wants to merge 1 commit into
Draft
Conversation
- Added Mermaid architecture diagram (§4.1) showing Project Owner, Build Phase, SBOM Generation Phase, and Verification Phase actors - Expanded role definitions (§4.2) with Witness attestor table - Added SBOMit components section (§4.3) - Added end-to-end Witness → Enriched SBOM walkthrough (§4.5) - Added use case scenarios (§4.4.2) Only ## 4 Overview is modified; all other chapters are untouched. Signed-off-by: jaydeep869 <jaydeeppokhariya2106@gmail.com>
Jaydeep869
force-pushed
the
feat/issue-35-overview
branch
from
August 30, 2026 11:00
4155e4c to
da0b7dc
Compare
Author
|
@absol27 @stupendoussuperpowers draft is ready, can you please review it. |
Jaydeep869
marked this pull request as draft
August 30, 2026 11:04
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
1 participant
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.
Overview
Chapter 4 previously contained only a brief high level description of the three step deployment flow, with no concrete explanation of the system architecture or how the tools interact. This PR completes the chapter with accurate, implementation backed content.
Changes
Involved Parties and Their Roles (4.2): Expanded each role with precise descriptions grounded in the actual tooling. Includes a reference table of Witness attestors (material, product, command-run, network-trace) and their predicate types.
SBOMit Components (4.3): Described the four primary implementation components and their responsibilities.
System Workflow Example (4.4): Retained the existing workflow diagram and implementation steps. Expanded the use case scenarios with corrected formatting and updated CycloneDX capitalisation.
End-to-End Walkthrough (4.5): Added a concrete worked example for a Go project, tracing the full pipeline from layout signing through witness run, attestation storage, sbomit generate, and final witness verify, with real commands at each step.