📚 Auto-generate documentation for n8n workflows with GPT and Docsify

Open on n8n.io

$20/month : Unlimited workflows

2500 executions/month

Try free

THE #1 IN WEB SCRAPING

Scrape any website without limits

Try free

HOSTINGER

Early Deal
DISCOUNT 20%

Self-hosted n8n

Unlimited workflows - from $4.99/mo

Try free

#1 hub for scraping, AI & automation

6000+ actors - $5 credits/mo

Try free

Important notice

This workflow is provided as-is. Please review and test before using in production.

1. Workflow Overview

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 forma...

Best for

Internal Wiki automation workflows
Multimodal AI automation workflows
advanced n8n builders looking for reusable templates

Tools used

n8n-nodes-base.set, n8n-nodes-base.converttofile, n8n-nodes-base.if, n8n-nodes-base.extractfromfile, n8n-nodes-base.html, n8n-nodes-base.sort, n8n-nodes-base.switch, n8n-nodes-base.readwritefile

Source and attribution

This workflow is cataloged by N8N Workflows and links back to its original n8n.io source page by Eduard.

Original n8n.io source

1.1 Workflow description

Title: 📚 Auto-generate documentation for n8n workflows with GPT and Docsify
Workflow name: 📚 Auto-generate documentation for n8n workflows with GPT and Docsify

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

Main 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 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:

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!

1.2 Logical Blocks

This catalog entry is organized from the workflow JSON. The node-level section below shows the executable blocks available for review before importing the template.

2. Block-by-Block Analysis

Block 1 - CONFIG

Type / Role: n8n-nodes-base.set - set
Config choices: Version 3.4

Block 2 - Convert to File

Type / Role: n8n-nodes-base.convertToFile - convertToFile
Config choices: Version 1.1

Block 3 - HasFile?

Type / Role: n8n-nodes-base.if - if
Config choices: Version 2.2

Block 4 - Extract from File

Type / Role: n8n-nodes-base.extractFromFile - extractFromFile
Config choices: Version 1

Block 5 - Main Page

Type / Role: n8n-nodes-base.html - html
Config choices: Version 1.2

Block 6 - Instance overview

Type / Role: n8n-nodes-base.html - html
Config choices: Version 1.2

Block 7 - Sort-workflows

Type / Role: n8n-nodes-base.sort - sort
Config choices: Version 1

Block 8 - doc action

Type / Role: n8n-nodes-base.switch - switch
Config choices: Version 3.2

Block 9 - Empty Set

Type / Role: n8n-nodes-base.set - set
Config choices: Version 3.4

Block 10 - Load Doc File

Type / Role: n8n-nodes-base.readWriteFile - readWriteFile
Config choices: Version 1

Block 11 - Respond with markdown

Type / Role: n8n-nodes-base.respondToWebhook - respondToWebhook
Config choices: Version 1.1

Block 12 - Respond with HTML

Type / Role: n8n-nodes-base.respondToWebhook - respondToWebhook
Config choices: Version 1.1

Block 13 - Save New Doc File

Type / Role: n8n-nodes-base.readWriteFile - readWriteFile
Config choices: Version 1

Block 14 - Blank Doc File

Type / Role: n8n-nodes-base.set - set
Config choices: Version 3.4

Block 15 - Fetch Single Workflow1

Type / Role: n8n-nodes-base.n8n - n8n
Config choices: Version 1

Block 16 - Fill Workflow Table

Type / Role: n8n-nodes-base.set - set
Config choices: Version 3.4

Block 17 - Basic LLM Chain

Type / Role: @n8n/n8n-nodes-langchain.chainLlm - chainLlm
Config choices: Version 1.4

Block 18 - OpenAI Chat Model

Type / Role: @n8n/n8n-nodes-langchain.lmChatOpenAi - lmChatOpenAi
Config choices: Version 1

Block 19 - Structured Output Parser

Type / Role: @n8n/n8n-nodes-langchain.outputParserStructured - outputParserStructured
Config choices: Version 1.2

Block 20 - Auto-fixing Output Parser

Type / Role: @n8n/n8n-nodes-langchain.outputParserAutofixing - outputParserAutofixing
Config choices: Version 1

Block 21 - Respond with main page HTML

Type / Role: n8n-nodes-base.respondToWebhook - respondToWebhook
Config choices: Version 1.1

Block 22 - Workflow Tags

Type / Role: n8n-nodes-base.html - html
Config choices: Version 1.2

Block 23 - No Operation, do nothing

Type / Role: n8n-nodes-base.noOp - noOp
Config choices: Version 1

Block 24 - Merge

Type / Role: n8n-nodes-base.merge - merge
Config choices: Version 3

Showing the first 24 of 60 workflow blocks. Download the JSON for the full node graph.

3. Summary Table

Workflow	📚 Auto-generate documentation for n8n workflows with GPT and Docsify
Complexity	advanced
Nodes	60
Categories	Internal Wiki, Multimodal AI
Author	Eduard
Published	22 Dec 2024

4. Reproducing the Workflow from Scratch

1. Download the workflow JSON

Use the JSON export at /data/workflows/2669/2669.json as the source template for this automation.
2. Import the template into n8n

Open n8n, import the downloaded JSON, and review each node before activating the workflow.
3. Configure credentials and variables

Replace placeholder credentials, API keys, webhook URLs, account IDs, and environment-specific values with your own settings.
4. Test with sample data

Run the workflow manually or in a staging workspace, inspect node output, and confirm downstream systems receive the expected data.
5. Activate and monitor

Enable the workflow only after testing, then monitor executions, errors, and rate limits during the first production runs.

5. General Notes & Resources

Review imported nodes carefully before activation. This catalog entry is intended to help you inspect the workflow structure, understand required services, and find related templates faster.

Node names, credentials, schedules, webhook paths, and external service limits may need adjustment for your workspace.

Download workflow JSON Original n8n.io source Internal Wiki workflows Multimodal AI workflows

Frequently asked questions

What does 📚 Auto-generate documentation for n8n workflows with GPT and Docsify do?

What do I need before importing this workflow?

Review the workflow JSON, configure any required credentials in n8n, and test the automation in a safe workspace before using it in production.

Can I customize this workflow?

Yes. Use the block-by-block analysis and the downloadable JSON to inspect each node, then adjust credentials, prompts, schedules, filters, or destinations for your Internal Wiki, Multimodal AI use case.

Eduard

24 workflows

Nodes

n8n-nodes-base.set n8n-nodes-base.converttofile n8n-nodes-base.if n8n-nodes-base.extractfromfile n8n-nodes-base.html n8n-nodes-base.sort n8n-nodes-base.switch n8n-nodes-base.readwritefile

Complexity

advanced

Published 22 Dec 2024

Likes 0

View on n8n.io Download Workflow

Install path: /data/workflows/2669/2669.json

Share Your Workflow

Have a useful automation to share? Publish it and help the community.

Submit Your Template How to Submit

Related Workflows

Build a RAG knowledge base from PDFs with Gemini, Supabase and Google Sheets

## Quick Overview This workflow ingests educational PDF URLs from Google Sheets, extracts and chunks their text, generates embeddings with Google Gemini, and stores them in a Supabase pgvector table for retrieval, while also exposing a public chat webhook that answers questions using Gemini and the same Supabase knowledge base. ## How it works 1. Runs every hour on a schedule and reads rows from a Google Sheets document, keeping only entries where the status is empty. 2. Processes each queued URL one at a time and routes it based on whether it is a seraj-uae.com page or a direct Google Drive file link. 3. For seraj-uae.com URLs, fetches the HTML page to extract the PDF download link (or embedded Google Drive file ID) and the document title. 4. Downloads the PDF from either the source website via HTTP or from Google Drive, waits briefly, and extracts text from the PDF binary. 5. Cleans and validates the extracted text, then splits it into overlapping chunks and generates embeddings using Google Gemini. 6. Inserts the embedded chunks into a Supabase pgvector table with file/title/source metadata and updates the Google Sheets row to “Embedded” or “Not Text Based PDF” if no text is found. 7. Separately, exposes a public n8n Chat webhook that receives student questions and uses Gemini Flash with Supabase vector retrieval to return answers. ## Setup 1. Create a Supabase project with pgvector enabled, create the seraj_documents table, and add the match_seraj_documents function used for vector search. 2. Add Supabase API credentials in n8n and ensure the table name (seraj_documents) and query function name (match_seraj_documents) match your Supabase setup. 3. Add Google Sheets OAuth2 credentials and update the Google Sheet document ID/sheet reference, ensuring columns include source_url, status, and row_number. 4. Add Google Drive OAuth2 credentials for downloading PDFs hosted in Drive. 5. Add a Google Gemini (PaLM) API credential for embeddings and Gemini Flash, then activate the workflow and copy the public chat webhook URL for your website chat widget.

View

Build a Slack knowledge graph with Claude, Neo4j and Google Sheets

## Quick Overview This workflow ingests chat messages via a webhook or a 15-minute schedule, filters out low-signal content, uses Anthropic Claude to extract entities and relationships, and stores the resulting knowledge graph in Neo4j while appending an audit log row to Google Sheets. ## How it works 1. Receives a chat message via an n8n webhook or runs every 15 minutes to process polled Slack data. 2. Normalizes the incoming payload into consistent fields like channel, sender, timestamp, and message text. 3. Uses a Python script to tag message signals (questions, decisions, action items) and filter out noise such as greetings, bots, and very short messages. 4. Sends each relevant message to Anthropic Claude to extract entities, relationships, a summary, message type, and importance. 5. Sends the extracted graph to Anthropic Claude again to add implicit relationships, weights, decision-chain metadata, and a thread category. 6. Merges both AI passes into a single nodes-and-edges knowledge graph, validates references and edge weights, and drops invalid graphs. 7. Upserts the graph into Neo4j via its transactional HTTP endpoint, appends an audit row to Google Sheets, and returns a JSON success response to the webhook caller. ## Setup 1. Add an Anthropic API credential and select the Claude model used by the two AI steps. 2. Configure Neo4j access by replacing the Neo4j HTTP endpoint URL and setting up HTTP Basic Auth credentials for your Neo4j instance. 3. Configure Google Sheets OAuth2 credentials and replace the placeholder Google Sheet ID, sheet tab name/range (KnowledgeGraph), and any required API permissions. 4. If using the webhook ingest path, copy the production webhook URL from n8n and configure your Slack/app integration to POST message payloads to `/chat-ingest` with the expected fields (text, channel, sender, timestamps).

View

Answer voice queries from a webhook over Google Drive docs using GPT-4o-mini and Supabase

## Quick overview Placetel AI – RAG Voice Assistant with Google Drive & Supabase ## How it works 1. Runs on a daily schedule at 02:00 or via manual start to reindex documents. 2. Lists files from a specified Google Drive folder and iterates through each file. 3. Downloads each Google Drive file, loads its text content, creates embeddings with OpenAI, and stores the resulting chunks in a Supabase vector table. 4. Receives a question via a POST webhook with a JSON body containing `chatInput`. 5. Generates an answer with GPT-4o-mini by semantically retrieving relevant passages from the Supabase vector store using the same OpenAI embeddings model. 6. Returns the generated, source-cited response to the webhook caller for voice output. ## Setup 1. Add Google Drive OAuth2 credentials and replace `DEINE_ORDNER_ID` in the Drive query with the folder you want to index. 2. Add an OpenAI API credential and ensure the same embeddings model/settings are used for both indexing and querying. 3. Create/configure a Supabase project with a `documents` table and the `match_documents` RPC/query used for vector search, then add your Supabase credentials. 4. Copy the webhook URL from the webhook trigger and configure your calling system to POST `{ "chatInput": "..." }` to it.

View

Need Custom Automation?

Get help designing a custom n8n workflow that connects your stack and fits your process.

📚 Auto-generate documentation for n8n workflows with GPT and Docsify

Workflow preview

Important notice

1. Workflow Overview

Best for

Tools used

Source and attribution

1.1 Workflow description

🔧 Key Components

⚙️ Technical Details

Environment Setup

⚠️ Security Considerations

Dependencies

🔍 Part of the n8n Observability Series

1.2 Logical Blocks

2. Block-by-Block Analysis

Block 1 - CONFIG

Block 2 - Convert to File

Block 3 - HasFile?

Block 4 - Extract from File

Block 5 - Main Page

Block 6 - Instance overview

Block 7 - Sort-workflows

Block 8 - doc action

Block 9 - Empty Set

Block 10 - Load Doc File

Block 11 - Respond with markdown

Block 12 - Respond with HTML

Block 13 - Save New Doc File

Block 14 - Blank Doc File

Block 15 - Fetch Single Workflow1

Block 16 - Fill Workflow Table

Block 17 - Basic LLM Chain

Block 18 - OpenAI Chat Model

Block 19 - Structured Output Parser

Block 20 - Auto-fixing Output Parser

Block 21 - Respond with main page HTML

Block 22 - Workflow Tags

Block 23 - No Operation, do nothing

Block 24 - Merge

3. Summary Table

4. Reproducing the Workflow from Scratch

1. Download the workflow JSON

2. Import the template into n8n

3. Configure credentials and variables

4. Test with sample data

5. Activate and monitor

5. General Notes & Resources

Frequently asked questions