Neo | DocsDrawing diagrams
You can ask Neo to generate class diagrams or sequence diagrams from pull requests and code.
-
From a pull request, just leave a comment saying something like “@neo draw a class diagram of the changes in this PR”. Neo will reply with a picture.
-
From a messenger (Slack or Teams), ask Neo for example “@neo draw a sequence diagram of the payment flow”. Neo will reply with a picture.
-
Assign a ticket to Neo - you must first label it
neo-arch, and link to a Confluence document for Neo to put the diagram in. Then assign the ticket to Neo.
Neo will explore the relevant code repository and find the files needed to draw the diagram. You can help this by giving it hints, e.g. “make sure to cover everything in src/caching/”, or “include every class derived from LLMResponse”.
Neo uses PlantUML for class diagrams and Mermaid for sequence diagrams. This will be displayed natively or as an image, depending on the tool. In Confluence, you must install the Mermaid diagrams viewer plugin.