diagram generation
- Repo stars 19,426
- Author repo opik
- Domain
- AI
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @comet-ml · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Diagram Generation
Generate self-contained HTML diagrams that visualize code changes, data flows, and architecture decisions.
## When to Use
- Visualizing PR changes for code review
- Explaining architectural decisions
- Documenting data/request flows
- Illustrating before/after comparisons
## Output
- Self-contained HTML file at `{MAIN_REPO_ROOT}/diagrams/opik-{TICKET_NUMBER}-diagram.html` — always resolved against the main repo root (via `git rev-parse --git-common-dir`), even when the session runs inside a worktree, so the file outlives the worktree
- Includes "Copy as image" button for sharing in Slack, Jira, PR descriptions
- Dark GitHub theme, semantic color coding, responsive layout
## How to Generate
Follow the style guide in `style-guide.md` and use the HTML template in `template.md`.
### Required Sections (pick what applies)
1. **Request / Data Flow** — how data moves through layers
2. **Why This Approach** — problem vs solution comparison
3. **Files Changed by Layer** — grid of affected files grouped by component
4. **Key Design Decisions** — numbered guards, trade-offs, or constraints
### Section Selection
- **Bug fix**: Focus on before/after flow, root cause, safety guards
- **New feature**: Focus on data flow, architecture, files changed
- **Refactor**: Focus on before/after architecture, files changed
- **Cross-component**: Show all layers with connecting flows
## Reference Files
- [style-guide.md](style-guide.md) — Semantic colors, box themes, section labels, flow patterns, architecture trees
- [template.md](template.md) — Base HTML structure, copy-as-image script, section recipes
## Common Gotchas
- **SRI hash on CDN scripts**: The html2canvas `<script>` tag must include `integrity` and `crossorigin` attributes — see template.md for the current hash
- **Absolute paths for Playwright screenshots**: Playwright saves relative to its own CWD, not the repo root — always use absolute paths when calling `browser_take_screenshot`
- **Max 4 sections**: More than 4 sections makes diagrams too tall for screenshots and hard to scan visually
- **No raw diff content**: Diagrams show high-level summaries (component names, file names, flow descriptions) — never embed verbatim diff hunks or Jira comments
- **`toBlob` can return null**: The Canvas `toBlob` call in the copy-as-image script needs a null check — see template.md
Sections and files
Listed in source order.
sections -> When to Use → Output → How to Generate → Required Sections (pick what applies) → Section Selection → Reference Files
terms -> Request / Data Flow · Why This Approach · Files Changed by Layer · Key Design Decisions · Bug fix · New feature · Refactor · Cross-component
files/cmd -> {MAIN_REPO_ROOT}/diagrams/opik-{TICKET_NUMBER}-diagram.html · git rev-parse --git-common-dir · style-guide.md · template.md · <script> · integrity · crossorigin · browser_take_screenshot
body sha256 -> 30b25aeb4e88
When to Use
Visualizing PR changes for code review Explaining architectural decisions Documenting data/request flows Illustrating before/after comparisons
Output
Self-contained HTML file at
{MAIN_REPO_ROOT}/diagrams/opik-{TICKET_NUMBER}-diagram.html— always resolved against the main repo root (viagit rev-parse --git-common-dir), even when the session runs inside a worktree, so the file outlives the worktree Includes "Copy as image" button for sharing in Slack, Jira, PR descriptions Dark GitHub theme, semantic color coding, responsive layoutHow to Generate
Follow the style guide in
style-guide.mdand use the HTML template intemplate.md.Required Sections (pick what applies)
Request / Data Flow — how data moves through layers Why This Approach — problem vs solution comparison Files Changed by Layer — grid of affected files grouped by component Key Design Decisions — numbered guards, trade-offs, or constraints
Section Selection
Bug fix: Focus on before/after flow, root cause, safety guards New feature: Focus on data flow, architecture, files changed Refactor: Focus on before/after architecture, files changed Cross-component: Show all layers with connecting flows