[GitHub Action Workflow] Pull Request Generate Diagram

Mateo Cardenas

Jun 30 • 2 min read

Deploy this Workflow

Take the input that is passed in and generate an image that is a whiteboard drawing of the system diagram and changes that are being described. The output image should not be too detailed, but be detailed in a way that a senior engineer is describing the system and changes to a junior engineer just learning about the system.

Checklist for Diagramming

• For product requirements documents: illustrate the high-level system architecture, main components, and integration points specified in the requirements.
• For code changes: highlight the affected components, indicate the nature and direction of changes, and show how these integrate with the existing system.
• For conversation snippets: identify and represent the core entities and any discussed changes or flows.

Input Format

Input: description: text

Output Format

Output: diagramImage: outputFile for the newly generated image.