# dwarvesf/handbook architecture

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

- Interactive diagram: https://gitdiagram.com/dwarvesf/handbook
- Repository: https://github.com/dwarvesf/handbook

## Overview

##### Main Components

a. Content Management Layer
- Markdown Documentation Files
- Assets Management
- Version Control System (Git)

b. Organization Structure
- Policy Documents
- Process Guidelines
- Company Information
- Learning Resources

c. Access & Distribution Layer
- GitHub Repository
- Web Access Interface
- Contribution System

**┌─────────────────────────────────────────────────┐**
- Access Layer                    │
- ┌─────────────┐  ┌──────────┐  ┌───────────┐  │
- GitHub    │  │   Web    │  │   Pull    │  │
- Interface  │  │  Access  │  │ Requests  │  │
- ┘  └──────────┘  └───────────┘  │
- ┘
- ▲

**┌─────────────────────────────────────────────────┐**
- Content Structure                   │
- ┌─────────────┐  ┌──────────┐  ┌───────────┐  │
- Company    │  │ Process  │  │ Learning  │  │
- Policies   │  │ Guides   │  │Resources  │  │
- ┘  └──────────┘  └───────────┘  │
- ┘
- ▲

**┌─────────────────────────────────────────────────┐**
- Storage Layer                       │
- ┌─────────────┐  ┌──────────┐  ┌───────────┐  │
- Markdown   │  │  Assets  │  │   Git     │  │
- Files     │  │  Store   │  │  Version  │  │
- ┘  └──────────┘  └───────────┘  │
- ┘

##### Important Elements to Highlight

a. Content Organization:
- Hierarchical structure of documentation
- Main categories (Introduction, Guides, Process)
- Relationship between different document types

b. Version Control:
- Git workflow
- Contribution paths
- Review process for pull requests

c. Asset Management:
- How images and other assets are stored and referenced
- Relationship between assets and markdown files

##### Key Relationships

- How content is organized and interlinked
- How contributions flow through the system
- How version control maintains document history
- How assets are managed and referenced

- Accessibility
- Maintainability
- Version control
- Contribution workflow
- Content organization

Remember to include notes about the GitHub-based workflow and how it facilitates collaborative editing and version control of the handbook.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Access
        GI[GitHub Interface]
        WA[Web Access]
        PR[Pull Requests]
    end

    subgraph Content
        direction TB
        CI[Company Information]:::info
        PP[Company Policies]:::policy
        PG[Process Guidelines]:::process
        LR[Learning Resources]:::learning
        GS[Getting Started]:::start
        WP[Work Processes]:::work
    end

    subgraph Storage
        MD[Markdown Files]
        AM[Assets Management]:::assets
        VC[Version Control]:::version
    end

    %% Relationships
    GI --> CI
    GI --> PP
    GI --> PG
    WA --> CI
    WA --> PP
    WA --> PG
    PR --> VC

    CI --> MD
    PP --> MD
    PG --> MD
    LR --> MD
    GS --> MD
    WP --> MD

    MD --> AM
    MD --> VC

    %% Click Events
    click AM "https://github.com/dwarvesf/handbook/blob/master/assets,guides/assets,guides/assets.md"
    click LR "https://github.com/dwarvesf/handbook/blob/master/learning/README.md,learning/sharing.md,learning/showcase.md,learning/tech-radar.md"
    click PG "https://github.com/dwarvesf/handbook/blob/master/guides/continuing-education-allowance.md,guides/email-communication-and-uses.md,guides/leave-request.md,guides/reimbursement.md"
    click PP "https://github.com/dwarvesf/handbook/blob/master/benefits-and-perks.md,compliance.md,security-rules.md,stock-option-plan.md"
    click CI "https://github.com/dwarvesf/handbook/blob/master/dwarves-foundation-is-you.md,what-we-stand-for.md,what-we-value.md,who-does-what.md,purpose.md"
    click WP "https://github.com/dwarvesf/handbook/blob/master/how-we-work.md,how-we-hire.md,hybrid-working.md,effective-meeting.md,one-on-one-meeting.md"
    click VC "https://github.com/dwarvesf/handbook/blob/master/.github/workflows/main.yml,.gitignore"
    click GS "https://github.com/dwarvesf/handbook/blob/master/getting-started.md,faq.md"

    %% Styling
    classDef assets fill:#f96,stroke:#333
    classDef version fill:#f96,stroke:#333
    classDef info fill:#58f,stroke:#333
    classDef policy fill:#5d5,stroke:#333
    classDef process fill:#5d5,stroke:#333
    classDef learning fill:#5d5,stroke:#333
    classDef start fill:#58f,stroke:#333
    classDef work fill:#5d5,stroke:#333

    %% Legend
    subgraph Legend
        L1[Storage Components]:::assets
        L2[Content Components]:::info
        L3[Process Components]:::process
    end
```
