# osmangoninahid/mermaidiff architecture

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

- Interactive diagram: https://gitdiagram.com/osmangoninahid/mermaidiff
- Repository: https://github.com/osmangoninahid/mermaidiff

## Overview

mermaidiff is an agent skill that turns a requested code change into a concise, evidence-backed behavior brief and sequence diagram, then renders it in a browser. The main path is request → change inspection → brief → browser view. README documents supported change sources and brief features; the sampled renderer shows how Markdown becomes HTML and how the reload signal is written. The skill instructions and viewer template were not sampled, so their internal behavior is represented only where documented.

Main entry points: [`skill/scripts/view.py`](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/scripts/view.py) (Brief renderer), [`skill/SKILL.md`](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/SKILL.md) (Skill instructions), [`skill/format.md`](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/format.md) (Brief format rules), [`skill/scripts/viewer.html`](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/scripts/viewer.html) (Viewer template)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Agent workflow"]
  node_agent["Coding agent"]
  node_skill["Skill instructions<br/>[SKILL.md]"]
  node_change["Requested change"]
  node_tools["Git and providers"]
end

subgraph group_brief["Brief generation"]
  node_format["Brief format rules<br/>[format.md]"]
  node_briefmd["Markdown brief"]
end

subgraph group_viewer["Browser presentation"]
  node_renderer["Brief renderer<br/>[view.py]"]
  node_template["Viewer template<br/>[viewer.html]"]
  node_html["Rendered page"]
end

node_user(("Engineer"))
node_browser["Web browser"]
node_mermaid["Mermaid CDN"]

node_user -->|"requests brief"| node_agent
node_agent -->|"follows instructions"| node_skill
node_user -->|"selects source"| node_change
node_agent -->|"gathers facts"| node_tools
node_agent -->|"uses rules"| node_format
node_agent -->|"writes brief"| node_briefmd
node_briefmd -->|"renders"| node_renderer
node_renderer -->|"reads and recounts"| node_briefmd
node_renderer -->|"loads template"| node_template
node_renderer -->|"writes page"| node_html
node_renderer -->|"opens page"| node_browser
node_html -->|"displays"| node_browser
node_browser -.->|"loads diagrams"| node_mermaid

click node_skill "https://github.com/osmangoninahid/mermaidiff/blob/main/skill/SKILL.md"
click node_format "https://github.com/osmangoninahid/mermaidiff/blob/main/skill/format.md"
click node_renderer "https://github.com/osmangoninahid/mermaidiff/blob/main/skill/scripts/view.py"
click node_template "https://github.com/osmangoninahid/mermaidiff/blob/main/skill/scripts/viewer.html"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_agent,node_skill,node_change,node_tools,node_browser toneBlue
class node_format,node_briefmd toneAmber
class node_renderer,node_template,node_html toneMint
class node_user,node_mermaid toneIndigo
```

## Components

### Agent workflow

- **Coding agent**
- [Skill instructions](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/SKILL.md): `skill/SKILL.md`
- **Requested change**
- **Git and providers**

### Brief generation

- [Brief format rules](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/format.md): `skill/format.md`
- **Markdown brief**

### Browser presentation

- [Brief renderer](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/scripts/view.py): `skill/scripts/view.py`
- [Viewer template](https://github.com/osmangoninahid/mermaidiff/blob/main/skill/scripts/viewer.html): `skill/scripts/viewer.html`
- **Rendered page**

### Other components

- **Engineer**
- **Web browser**
- **Mermaid CDN**

## Connections

- Engineer → Coding agent: requests brief (evidence: `README.md`)
- Coding agent → Skill instructions: follows instructions (evidence: `README.md`)
- Engineer → Requested change: selects source (evidence: `README.md`)
- Coding agent → Git and providers: gathers facts
- Coding agent → Brief format rules: uses rules (evidence: `README.md`)
- Coding agent → Markdown brief: writes brief (evidence: `README.md`)
- Markdown brief → Brief renderer: renders (evidence: `skill/scripts/view.py`)
- Brief renderer → Markdown brief: reads and recounts (evidence: `skill/scripts/view.py`)
- Brief renderer → Viewer template: loads template (evidence: `skill/scripts/view.py`)
- Brief renderer → Rendered page: writes page (evidence: `skill/scripts/view.py`)
- Brief renderer → Web browser: opens page (evidence: `skill/scripts/view.py`)
- Rendered page → Web browser: displays (evidence: `README.md`)
- Web browser → Mermaid CDN: loads diagrams (evidence: `README.md`)
