Skip to content

Conversation

@plfavreau
Copy link
Collaborator

@plfavreau plfavreau commented Sep 1, 2025

🚀 What's new?

This PR adds automatic graph documentation generation for the LangGraph structure. Specifcally, it adds a new github workflow to automatically update graph visualization when graph structure changes :

  • Created Python script to generate graph visualization as PNG using Mermaid
  • Updated README with a new "Agentic System Overview" section displaying the graph
  • Added necessary dependencies and configurations for graph generation
  • Configured workflow to commit and push changes automatically, only when the graph is updated.

🤔 Type of Change

What kind of change is this? Mark with an x

  • Bug fix (non-breaking change that solves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update to the docs)

✅ Checklist

Before you submit, please make sure you've done the following. If you have any questions, we're here to help!

  • I have read the Contributing Guide.
  • My code follows the project's style guidelines (ruff check . and ruff format . pass).
  • I have added necessary documentation (if applicable).

💬 Any questions or comments?

Have a question or need some help? Join us on Discord!

@plfavreau plfavreau self-assigned this Sep 1, 2025
@plfavreau plfavreau changed the title ci: generate graph visualization on PR open feat(docs): Implement automatic graph documentation generation Sep 1, 2025
@plfavreau plfavreau force-pushed the TASK-173/automatic-langgraph-graph-documentation branch from 0c02e88 to 1655f5c Compare September 1, 2025 12:57
@plfavreau plfavreau requested a review from KYN4 September 1, 2025 12:57
@plfavreau plfavreau marked this pull request as ready for review September 1, 2025 12:57
Copy link
Collaborator

@KYN4 KYN4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! Very handy workflow :D

@plfavreau plfavreau merged commit 1ba0e75 into main Sep 1, 2025
3 checks passed
@plfavreau plfavreau deleted the TASK-173/automatic-langgraph-graph-documentation branch September 1, 2025 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants