π Auto-generate documentation for n8n workflows with GPT and Docsify
Ready for 3.0Ready for 3.0. This template uses no nodes that n8n 3.0 removes. No removed nodes, versions or helpers found. Static check, last run 2026-10-19.
Nodes used (19)
- Edit Fields (Set)
n8n-nodes-base.set - Convert to File
n8n-nodes-base.convertToFile - If
n8n-nodes-base.if - Extract from File
n8n-nodes-base.extractFromFile - HTML
n8n-nodes-base.html - Sort
n8n-nodes-base.sort - Switch
n8n-nodes-base.switch - Read/Write Files from Disk
n8n-nodes-base.readWriteFile - Respond to Webhook
n8n-nodes-base.respondToWebhook - n8n
n8n-nodes-base.n8n - Basic LLM Chain
@n8n/n8n-nodes-langchain.chainLlm - OpenAI Chat Model
@n8n/n8n-nodes-langchain.lmChatOpenAi - Structured Output Parser
@n8n/n8n-nodes-langchain.outputParserStructured - Auto-fixing Output Parser
@n8n/n8n-nodes-langchain.outputParserAutofixing - No Operation, do nothing
n8n-nodes-base.noOp - Merge
n8n-nodes-base.merge - Execute Command
n8n-nodes-base.executeCommand - Code
n8n-nodes-base.code - Webhook
n8n-nodes-base.webhook
What it does
This workflow creates a documentation system for n8n instances using Docsify.js. It serves a dynamic documentation website that allows users to: - View an overview of all workflows in a tabular format - Filter workflows by tags - Access automatically generated documentation for each workflow - Edit documentation with a live Markdown preview - Visualize workflow structures using Mermaid.js diagrams > πΊ Check out the short 2-min demonstration on LinkedIn. Don't forget to connect! π§ Key Components 1. Main Documentation Portal - Serves a Docsify-powered website - Provides a navigation sidebar with workflow tags - Displays workflow status, creation date, and documentation links 2. Documentation Generator - Uses GPT model to auto-generate workflow descriptions - Creates Mermaid.js diagrams of workflow structures - Maintains consistent documentation format 3. Live Editor - Split-screen Markdown editor with preview - Real-time Mermaid diagram rendering - Save/Cancel functionality βοΈ Technical Details Environment Setup - Requires write access to the specified project directory - Uses environment variables for n8n instance URL configuration - Implements webhook endpoints for serving documentation β οΈ Security Considerations > Note: The current implementation doesn't include authentication for editing. Consider adding authentication for production use. Dependencies - Docsify.js for documentation rendering - Mermaid.js for workflow visualization - OpenAI GPT for documentation generation π Part of the n8n Observability Series This workflow is part of a broader series focused on n8n instance observability. Check out these related workflows: 1. Workflow Dashboard - Get comprehensive analytics of your n8n instance 2. Visualize Your n8n Workflows with Mermaid.js - Create beautiful workflow visualizations Each workflow in this series helps you better understand and manage your n8n automation ecosystem!