Auto-generate n8n Workflow Documentation with GPT & Docsify

Contributed by Sabrina Ramonov 🍄. From the community directory at agents.sabrina.dev, republished with permission and full credit.

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 ComponentsMain Documentation Portal

- Serves a Docsify-powered website

- Provides a navigation sidebar with workflow tags

- Displays workflow status, creation date, and documentation links

Documentation Generator

- Uses GPT model to auto-generate workflow descriptions

- Creates Mermaid.js diagrams of workflow structures

- Maintains consistent documentation format

Live Editor

- Split-screen Markdown editor with preview

- Real-time Mermaid diagram rendering

- Save/Cancel functionality

Technical DetailsEnvironment 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.

Part of the n8n Observability Series

This workflow is part of a broader series focused on n8n instance observability. Check out these related workflows:

- Workflow Dashboard - Get comprehensive analytics of your n8n instance

- 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!

Tools used: OpenAI, Docsify, Mermaid.js