# romenrg/evergreen-skills-developers architecture

> Architecture diagram of the GitHub repository romenrg/evergreen-skills-developers, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/romenrg/evergreen-skills-developers
- Repository: https://github.com/romenrg/evergreen-skills-developers

## Overview

##### Project type and purpose
- This is a documentation-only, open-source knowledge base (“evergreen skills” for software developers) rather than a running application.
- Purpose: serve as a canonical list of cross-framework, language-agnostic technical and non-technical skills to guide technical interviews and self-study.

##### File structure
- Top-level files:
- README.md – main content.
- CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE, changelog.md – governance and versioning.
- .github/ – community workflows (issue & PR templates, funding).
- .spelling – custom dictionary for linting markdown.
- No src/ or bin/ folders – no application code, only markdown docs.
- CI integration: badge in README references Codeship.

##### README for additional insights
- It describes the content hierarchy (non-technical vs technical skills, sub-topics).
- Mentions contributions workflow and that it’s WIP.

a. Main components
- Author/Contributor (Dev)
- GitHub repository (content store)
- CI pipeline (Codeship)
- Publishing layer (e.g. GitHub Pages or other static-site host)
- Community feedback channels (Issues, PRs)
b. Relationships & interactions
- Dev forks/clones → edits markdown → pushes branch → opens PR
- GitHub triggers Codeship CI → runs markdown linting/spelling checks → returns status
- On merge to master → GitHub Pages automatic rebuild & deploy (or manual deploy via CI)
- Community interacts via issues/templates → triggers notifications → backlog
c. Architectural patterns/principles
- “Docs as code”: treat markdown files in Git as source.
- Continuous Integration for linting and quality.
- Pull Request reviews for quality control and governance.
- Immutable artifacts: each commit maps to a versioned document.
d. Key technologies
- Git & GitHub for version control and hosting.
- Codeship for CI checks (spelling, markdown lint).
- Markdown as source format.
- GitHub Pages (or equivalent SSG) for static site hosting.

##### Details to capture
- Issue & PR templates enforcing contribution standards.
- Spelling/grammar checks via .spelling config.
- Changelog tracking for releases.
- License & code-of-conduct as governance artifacts.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Developer and Community
    CW["Contributor Workstation"]:::dev
    Community["Community"]:::dev

    %% Repository Subgraph
    subgraph "GitHub Repository"
        direction TB
        RepoMain["Repository (master branch)"]:::repo
        README["README.md"]:::repo
        CONTRIB["CONTRIBUTING.md"]:::repo
        CODEC["CODE_OF_CONDUCT.md"]:::repo
        LICENSE["LICENSE"]:::repo
        CHANGELOG["changelog.md"]:::repo
        ISSUE_TMPL[".github/ISSUE_TEMPLATE/"]:::repo
        PR_TMPL[".github/pull_request_template.md"]:::repo
        FUNDING[".github/FUNDING.yml"]:::repo
        SPELL[".spelling"]:::repo
    end

    %% Continuous Integration
    CI["Codeship CI"]:::ci

    %% Deployment
    Host["Static Site Host"]:::deploy

    %% Flows
    CW -->|"fork/clone → edit markdown → push branch"| RepoMain
    CW -->|"open Pull Request"| RepoMain
    Community -->|"open Issue"| ISSUE_TMPL
    Community -->|"review PR"| RepoMain
    RepoMain -->|"GitHub triggers CI"| CI
    CI -->|"run markdown lint & spelling checks"| RepoMain
    RepoMain -->|"merge → master triggers deploy"| Host

    %% Click Events
    click README "https://github.com/romenrg/evergreen-skills-developers/blob/master/README.md"
    click CONTRIB "https://github.com/romenrg/evergreen-skills-developers/blob/master/CONTRIBUTING.md"
    click CODEC "https://github.com/romenrg/evergreen-skills-developers/blob/master/CODE_OF_CONDUCT.md"
    click LICENSE "https://github.com/romenrg/evergreen-skills-developers/tree/master/LICENSE"
    click CHANGELOG "https://github.com/romenrg/evergreen-skills-developers/blob/master/changelog.md"
    click ISSUE_TMPL "https://github.com/romenrg/evergreen-skills-developers/tree/master/.github/ISSUE_TEMPLATE/"
    click PR_TMPL "https://github.com/romenrg/evergreen-skills-developers/blob/master/.github/pull_request_template.md"
    click FUNDING "https://github.com/romenrg/evergreen-skills-developers/blob/master/.github/FUNDING.yml"
    click SPELL "https://github.com/romenrg/evergreen-skills-developers/blob/master/.spelling"

    %% Styles
    classDef dev fill:#ccffcc,stroke:#333,stroke-width:1px
    classDef repo fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef ci fill:#ffe0b3,stroke:#333,stroke-width:1px
    classDef deploy fill:#e0ccff,stroke:#333,stroke-width:1px
```
