Self-Generating N8N Instance Documentation

Hey Everyone! 👋 New to the forum here. Awesome to meet you all and I'm pumped to connect.

I have an N8N case I'm curious to get people's take on. I'm trying to dynamically generate documentation of my entire N8N instance and wanted to see if people had successfully done implementations of this. I can see this being a real rabbithole with a billion different types of possible implementations I could do so I'm looking to lean on the wisdom of the community here 🧠

What I'm thinking is something along the lines of:

Pull all N8N workflow configs for workflows I want to document (N8N GET /workflows node)
Run each config through a GPT node that will generate documentation markdown
Run each config through some type of node (TBD - would love inspo here) that will take in an N8N config file and spit out a workflow diagram (possibly .html/.vsdx)
Push the markdown and visualization into a page within Notion/Readme

I would then refresh this for all production grade automations I have in the instance probably 1x/day.

If anyone has a go-to implementation for this and is willing to share some specs let me have em! If not I'll take any and all ideas folks have particularly for the step that creates the visualization step dynamically. Thanks all! Happy Monday.

9 comments