Docsify example

This workflow is designed for:

• Developers looking to automate documentation processes for their n8n workflows.
• Project Managers needing a clear overview of workflow statuses and documentation.
• Technical Writers who want to create or edit documentation dynamically based on workflow changes.
• DevOps Engineers aiming to integrate documentation generation into CI/CD pipelines.

The user base spans across various industries, including tech startups, software development firms, and enterprise-level organizations.

This workflow addresses the challenge of maintaining up-to-date documentation for n8n workflows. It automates the generation of Markdown documentation, enabling users to:

• View existing documentation easily.
• Edit documentation in real-time using a live Markdown editor.
• Auto-generate documentation if a file is missing, ensuring that no workflow goes undocumented.
• Save changes to documentation, minimizing manual effort and ensuring accuracy.

1. Trigger: The workflow is initiated via a webhook, which can handle various file requests (e.g., view, edit, save).
2. Configuration: Essential parameters like project_path and instance_url are set in the CONFIG node.
3. File Operations: It checks if a requested file exists. If it does, it extracts its content; if not, it creates a blank document template.
4. View/Edit Modes: Depending on the action (view/edit/save), the workflow routes to the appropriate node, either displaying the document or allowing edits.
5. Markdown Generation: The workflow dynamically generates Markdown documentation using the workflow data, including a mermaid chart for visual representation.
6. Saving Changes: When users save edits, the workflow writes the updated content back to the specified file location.
7. Response: Finally, it responds with the generated HTML or Markdown content, ensuring users receive the correct format based on their request.