diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index a0c5d68f..95f22e87 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -5,6 +5,7 @@ SPDX-License-Identifier: MIT --> - [Introduction](./README.md) +- [Architecture](./architecture/README.md) - [Contributing](./contributing/README.md) - [Governance](./governance/README.md) - [Security](./security/README.md) diff --git a/docs/src/architecture/README.md b/docs/src/architecture/README.md new file mode 100644 index 00000000..6e92f99b --- /dev/null +++ b/docs/src/architecture/README.md @@ -0,0 +1,40 @@ + + +# Architecture + +```mermaid +flowchart TB +inputs[Other inputs] + makes_cli[Makes CLI] + makes_framework[Makes Framework] + slsa_provenance[SLSA Provenance Attestation] + nix_derivation[Nix Derivation SBOM] + nix_store_path[Nix Store Path - Built artifact] + nixpkgs_collection[Nixpkgs Software Packages] + nixpkgs_module_system[Nixpkgs Module System] + consumer[Consumer] + developer[Developer] + project[Project] + git_repo[Git Repository] + ci_cd_code[CI/CD as code] + inputs[Other inputs] + + consumer -- uses --> makes_cli + ci_cd_code -- uses --> nixpkgs_collection + ci_cd_code -- uses --> makes_framework + ci_cd_code -- uses --> inputs + developer -- uses --> makes_cli + developer -- maintains --> project + git_repo -- is fetched by --> makes_cli + git_repo -- contains --> ci_cd_code + makes_cli -- uses --> nix + makes_cli -- produces --> slsa_provenance + makes_framework -- uses --> nixpkgs_module_system + nix -- produces --> nix_derivation + nix -- produces --> nix_store_path + project -- has --> git_repo +```