# sconetto/msa-docs architecture

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

- Interactive diagram: https://gitdiagram.com/sconetto/msa-docs
- Repository: https://github.com/sconetto/msa-docs

## Overview

##### Main Components

a) Documentation System Components:
- MkDocs Server (Core Documentation Engine)
- Markdown Processing Layer
- Static Site Generator
- Live Reload Server

b) Microservice API Modules (identified from the structure):
- Authentication Service (api-auth)
- Paycheck Service (api-paycheck)
- Registration Service (api-register)
- Vacation Service (api-vacation)
- Frontend Registration Module (front-register)

**┌─────────────────────────────────────────┐**
- MkDocs Server                │
- (Serving at http://127.0.0.1:8000)    │
- ┘

**┌─────────────────┐ ┌─────────────────┐**
- Markdown      │ │    Static Site  │
- Processor     │ │    Generator    │
- ┘ └─────────────────┘

**┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐**
- Auth  │ │Paycheck│ │Register│ │Vacation│
- API   │ │  API   │ │  API   │ │  API   │
- ┘ └────────┘ └────────┘ └────────┘

##### Key Elements to Highlight

- Blue: Documentation interface components
- Green: Processing components
- Orange: API documentation sources
- Purple: Frontend components

- Documentation flow from source files to processed output
- Live reload feedback loop
- API interface connections

##### Additional Details

- Environment Setup:
- Virtual Environment (virtualenvwrapper)
- Pipenv dependencies
- Python runtime

- File Organization:
- Separation between docs/, interfaces/, and modules/ directories
- Location of API Blueprint files (.apib)

##### Technical Stack Indicators

- Python
- MkDocs
- Markdown
- API Blueprint
- Pipenv
- Virtualenv

Remember to include a notes section explaining:
- Documentation workflow
- Build process
- Deployment steps
- Local development setup

This will provide a comprehensive view of both the documentation system's architecture and its relationship with the microservices it describes.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Main Components
    MkDocs["MkDocs Server<br/>(127.0.0.1:8000)"]:::server
    click MkDocs "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/mkdocs.yml"
    
    %% Processing Layer
    subgraph Processing
        MarkdownProc["Markdown<br/>Processor"]:::processor
        StaticGen["Static Site<br/>Generator"]:::processor
        click StaticGen "https://github.com/sconetto/msa-docs/tree/develop/msa-docs/site/"
        LiveReload["Live Reload<br/>Server"]:::server
    end
    
    %% Documentation Sources
    subgraph "Documentation Sources"
        MarkdownSrc["Markdown<br/>Source Files"]:::source
        click MarkdownSrc "https://github.com/sconetto/msa-docs/tree/develop/msa-docs/docs/"
        APIBlueprints["API Blueprint<br/>Files"]:::source
    end
    
    %% API Services
    subgraph "API Services Documentation"
        AuthAPI["Authentication<br/>Service"]:::api
        click AuthAPI "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/interfaces/api-auth.apib"
        PaycheckAPI["Paycheck<br/>Service"]:::api
        click PaycheckAPI "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/interfaces/api-paycheck.apib"
        RegisterAPI["Registration<br/>Service"]:::api
        click RegisterAPI "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/interfaces/api-register.apib"
        VacationAPI["Vacation<br/>Service"]:::api
        click VacationAPI "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/interfaces/api-vacation.apib"
    end
    
    %% Frontend Components
    subgraph "Frontend Documentation"
        FrontReg["Frontend<br/>Registration"]:::frontend
        click FrontReg "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/modules/front-register.md"
    end
    
    %% Solution Documentation
    subgraph "Solution Documentation"
        Architecture["Architecture<br/>Documentation"]:::solution
        click Architecture "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/solution/architecture.md"
        Overview["System<br/>Overview"]:::solution
        click Overview "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/docs/solution/overview.md"
    end
    
    %% Search Components
    subgraph "Search Functionality"
        SearchIndex["Search<br/>Index"]:::search
        click SearchIndex "https://github.com/sconetto/msa-docs/blob/develop/msa-docs/site/search/search_index.json"
        SearchImpl["Search<br/>Implementation"]:::search
        click SearchImpl "https://github.com/sconetto/msa-docs/tree/develop/msa-docs/site/assets/javascripts/lunr/"
    end
    
    %% Relationships
    AuthAPI & PaycheckAPI & RegisterAPI & VacationAPI --> APIBlueprints
    APIBlueprints & MarkdownSrc --> MarkdownProc
    MarkdownProc --> StaticGen
    StaticGen --> MkDocs
    MkDocs --> LiveReload
    LiveReload -.-> MkDocs
    Architecture & Overview --> MarkdownSrc
    FrontReg --> MarkdownSrc
    StaticGen --> SearchIndex
    SearchIndex --> SearchImpl
    
    %% Styles
    classDef server fill:#6495ED,stroke:#333,stroke-width:2px
    classDef processor fill:#90EE90,stroke:#333,stroke-width:2px
    classDef source fill:#F0E68C,stroke:#333,stroke-width:2px
    classDef api fill:#FFA07A,stroke:#333,stroke-width:2px
    classDef frontend fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef solution fill:#20B2AA,stroke:#333,stroke-width:2px
    classDef search fill:#FFB6C1,stroke:#333,stroke-width:2px
    
    %% Legend
    subgraph Legend
        L1["Server Component"]:::server
        L2["Processor"]:::processor
        L3["Source Files"]:::source
        L4["API Service"]:::api
        L5["Frontend"]:::frontend
        L6["Solution Docs"]:::solution
        L7["Search System"]:::search
    end
```
