# codehex16/documentazione architecture

> Architecture diagram of the GitHub repository codehex16/documentazione, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/codehex16/documentazione
- Repository: https://github.com/codehex16/documentazione

## Overview

##### Main Components
- Create distinct blocks for the major parts:
- Candidatura: Contains both the actual PDF deliverables and “source” typ files. Also includes “verbali” (minutes) which further divide into “esterni” (external) and “interni” (internal) with their own sources.
- RTB: Similar structure with requirements, planning, and technical documents. Again, note segmentation into “imgs”, source files, and verbali (with external and internal subfolders).
- PB: Contains documents like the “Manuale-utente” and “Specifica-Tecnica” along with their source files.
- Diari di Bordo: A set of daily logs kept as PDFs without a source folder.
- Glossario: The glossary document, along with its corresponding source.
- Template: Contains the templates and shared assets like images used to generate or standardize the other document types.
- Additionally, the .github directory represents the automated processes (CI/CD workflows) involved in, for example, compiling the source documents. You may consider this as an “Automation/Build” component.

##### Relationships and Interactions
- Document-related folders under an overarching “Documentazione” component.
- For directories containing “verbali”, illustrate the split between “interni” and “esterni” and link their source variants to the finished PDF versions.

##### Architectural Patterns and Design Principles
- Modularization: The repository is clearly divided into distinct modules (Candidatura, RTB, PB, etc.) so model these as separate blocks.
- Maintainability/Standardization: The use of a centralized template indicates that all documents follow a uniform style. This pattern should be highlighted as it is a key design decision for consistency.

##### Relevant Technologies and Tools
- Typographic processing tool (assumed from the *.typ files) as part of the transformation pipeline.
- GitHub Actions (workflows for document compilation and checks) as part of the CI/CD mechanism.
- If any additional static assets (e.g., images in the Template/images folder) play a role in document rendering, include them as supporting resources.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Documentazione Group
    subgraph "Documentazione"
        %% Candidatura Module
        subgraph "Candidatura"
            CandidaturaModule["Candidatura Module"]:::module
            A1["Source (.typ)"]:::source
            A2["PDF Deliverable"]:::pdf
            A3["Verbali Interni Source (.typ)"]:::source
            A4["Verbali Interni PDF"]:::pdf
            A5["Verbali Esterni Source (.typ)"]:::source
            A6["Verbali Esterni PDF"]:::pdf
            
            CandidaturaModule --> A1
            A1 --> A2
            CandidaturaModule --> A3
            A3 --> A4
            CandidaturaModule --> A5
            A5 --> A6
        end

        %% RTB Module
        subgraph "RTB"
            RTBModule["RTB Module"]:::module
            B1["Source (.typ)"]:::source
            B2["PDF Deliverable"]:::pdf
            B3["Verbali Interni Source (.typ)"]:::source
            B4["Verbali Interni PDF"]:::pdf
            B5["Verbali Esterni Source (.typ)"]:::source
            B6["Verbali Esterni PDF"]:::pdf
            
            RTBModule --> B1
            B1 --> B2
            RTBModule --> B3
            B3 --> B4
            RTBModule --> B5
            B5 --> B6
        end

        %% PB Module
        subgraph "PB"
            PBModule["PB Module"]:::module
            C1["Source (.typ)"]:::source
            C2["PDF Deliverable"]:::pdf
            
            PBModule --> C1
            C1 --> C2
        end

        %% Diari di Bordo
        subgraph "Diari di Bordo"
            D1["PDF Daily Logs"]:::pdf
        end

        %% Glossario
        subgraph "Glossario"
            GlossarioDoc["Glossario Source (.typ)"]:::source
            E2["PDF Glossario"]:::pdf
            
            GlossarioDoc --> E2
        end
    end

    %% Supporting Components
    F["Template Files & Assets"]:::template
    G["CI/CD Workflows"]:::ci

    %% Arrows from Template to Source Components
    F --> A1
    F --> A3
    F --> A5
    F --> B1
    F --> B3
    F --> B5
    F --> C1
    F --> GlossarioDoc

    %% Arrows from CI/CD Workflows to Source Components
    G --> A1
    G --> A3
    G --> A5
    G --> B1
    G --> B3
    G --> B5
    G --> C1
    G --> GlossarioDoc

    %% Styles
    classDef module fill:#fdf6e3,stroke:#657b83,stroke-width:2px;
    classDef source fill:#eee8d5,stroke:#586e75,stroke-width:2px;
    classDef pdf fill:#b58900,stroke:#002b36,stroke-width:2px;
    classDef template fill:#268bd2,stroke:#073642,stroke-width:2px;
    classDef ci fill:#2aa198,stroke:#073642,stroke-width:2px;

    %% Click Events for Component Mapping
    click CandidaturaModule "https://github.com/codehex16/documentazione/tree/main/candidatura/"
    click A1 "https://github.com/codehex16/documentazione/tree/main/candidatura/source/"
    click A3 "https://github.com/codehex16/documentazione/tree/main/candidatura/verbali/interni/source/"
    click A5 "https://github.com/codehex16/documentazione/tree/main/candidatura/verbali/esterni/source/"

    click RTBModule "https://github.com/codehex16/documentazione/tree/main/RTB/"
    click B1 "https://github.com/codehex16/documentazione/tree/main/RTB/source/"
    click B3 "https://github.com/codehex16/documentazione/tree/main/RTB/verbali/interni/source/"
    click B5 "https://github.com/codehex16/documentazione/tree/main/RTB/verbali/esterni/source/"

    click PBModule "https://github.com/codehex16/documentazione/tree/main/PB/"
    click C1 "https://github.com/codehex16/documentazione/tree/main/PB/source/"

    click D1 "https://github.com/codehex16/documentazione/tree/main/diari-di-bordo/"

    click GlossarioDoc "https://github.com/codehex16/documentazione/tree/main/glossario/source/"

    click F "https://github.com/codehex16/documentazione/tree/main/template/"
    click G "https://github.com/codehex16/documentazione/tree/main/.github/workflows/"
```
