How osmangoninahid/mermaidiff works
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: view.py Brief renderer · SKILL.md Skill instructions · format.md Brief format rules · viewer.html Viewer template
Components 12
Agent workflow
- Coding agent
- Skill instructions
skill/SKILL.md - Requested change
- Git and providers
Brief generation
- Brief format rules
skill/format.md - Markdown brief
Browser presentation
- Brief renderer
skill/scripts/view.py - Viewer template
skill/scripts/viewer.html - Rendered page
Other components
- Engineer
- Web browser
- Mermaid CDN
Connections 13
- Engineer → Coding agent: requests brief
README.md - Coding agent → Skill instructions: follows instructions
README.md - Engineer → Requested change: selects source
README.md - Coding agent → Git and providers: gathers facts
- Coding agent → Brief format rules: uses rules
README.md - Coding agent → Markdown brief: writes brief
README.md - Markdown brief → Brief renderer: renders
skill/scripts/view.py - Brief renderer → Markdown brief: reads and recounts
skill/scripts/view.py - Brief renderer → Viewer template: loads template
skill/scripts/view.py - Brief renderer → Rendered page: writes page
skill/scripts/view.py - Brief renderer → Web browser: opens page
skill/scripts/view.py - Rendered page → Web browser: displays
README.md - Web browser → Mermaid CDN: loads diagrams
README.md