From d09d9a7c8f53d95ff8bba13cc97ef45435ace6be Mon Sep 17 00:00:00 2001 From: Felipe Domingues Date: Sun, 12 Apr 2026 14:01:31 -0300 Subject: [PATCH] feat: release Vibeflow n8n v0.7.0 --- CHANGELOG.md | 26 +++-- README.md | 123 +++++++++++----------- VERSION | 2 +- docs/readme-premium-checklist.md | 38 +++++++ docs/real-demo-playbook.md | 59 +++++++++++ docs/release-v0.7.0.md | 15 +++ examples/sample-workflow-export.json | 57 ++++++++++ recipes/customer-support-escalation.md | 35 ++++++ recipes/hubspot-to-slack-qualification.md | 34 ++++++ 9 files changed, 315 insertions(+), 74 deletions(-) create mode 100644 docs/readme-premium-checklist.md create mode 100644 docs/real-demo-playbook.md create mode 100644 docs/release-v0.7.0.md create mode 100644 examples/sample-workflow-export.json create mode 100644 recipes/customer-support-escalation.md create mode 100644 recipes/hubspot-to-slack-qualification.md diff --git a/CHANGELOG.md b/CHANGELOG.md index d91372a..d3f5bc4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Changelog +## 0.7.0 + +- refreshed README for a stronger public-facing landing experience +- added a real-demo playbook for terminal-to-n8n walkthroughs +- added README premium checklist for launch polish +- added customer support escalation and HubSpot-to-Slack qualification recipes +- added an illustrative sample workflow export JSON for documentation and local experimentation +- added release notes for v0.7.0 + +## 0.6.0 + +- added showcase-oriented demo docs +- added placeholder SVG assets for hero, terminal, workflow, and report visuals +- added AI lead enrichment and Slack-to-Notion triage recipes +- updated README to highlight demo flow and stronger launch materials +- updated roadmap for a showcase-ready release + ## 0.5.0 - Added launch-ready branding files, including logo and social preview SVG assets @@ -72,12 +89,3 @@ Initial public skeleton of the Vibeflow n8n skill kit. - system prompt - intake and final report templates - example plans and briefs - - -## 0.6.0 - -- added showcase-oriented demo docs -- added placeholder SVG assets for hero, terminal, workflow, and report visuals -- added AI lead enrichment and Slack-to-Notion triage recipes -- updated README to highlight demo flow and stronger launch materials -- updated roadmap for a showcase-ready release diff --git a/README.md b/README.md index e9695d3..67d7e1f 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,18 @@ Build complete n8n workflows through MCP with any coding agent. Ask for the goal, generate a plan, build the workflow, validate it, and hand back a usable automation fast. +**Planning-first n8n workflow generation for Codex, Claude Code, OpenCode, and other MCP-capable clients.** + Português logo abaixo. +## What you get + +- A practical **system prompt** for planning-first workflow generation +- A **conversation contract** that keeps discovery short and useful +- A normalized **plan schema** before any workflow is built +- Client setup examples for **Codex**, **Claude Code**, and **OpenCode** +- Demo-friendly **recipes**, visuals, launch copy, and release assets + ## Why this exists Most people do not want to handcraft automation JSON, memorize node quirks, or map every edge case before the first test. They want to describe the workflow they need and let an agent do the heavy lifting. @@ -29,7 +39,7 @@ Experimental or community compatibility: - OpenClaude and similar MCP-capable forks -## What the skill does +## How it works The skill follows a simple five-step loop: @@ -55,6 +65,14 @@ This keeps the user experience practical and intuitive, closer to vibe coding th └── .github/ ``` +## Start here + +- `docs/getting-started.md` +- `docs/install.md` +- `templates/system-prompt.md` +- `docs/conversation-contract.md` +- `schemas/plan.schema.json` + ## Quick start 1. Connect an MCP-capable client to the n8n MCP server. @@ -62,19 +80,33 @@ This keeps the user experience practical and intuitive, closer to vibe coding th 3. Ask the agent to design or build a workflow in natural language. 4. Let the agent gather the missing details, generate a plan, and build. -Start here: +Example request: -- `docs/getting-started.md` -- `docs/install.md` -- `templates/system-prompt.md` -- `docs/conversation-contract.md` +```text +Build me an n8n workflow that watches a Gmail inbox for invoices, +saves PDF attachments to Google Drive, extracts key fields, +logs them to a spreadsheet, and posts failures to Slack. +Use safe defaults and ask only critical missing questions. +``` -## Demo flow +## What makes the workflow handoff good + +A successful run should leave the user with: + +- a clearly named workflow +- a documented trigger and end state +- noted assumptions and safe defaults +- credential gaps called out explicitly +- a compact test plan +- obvious next upgrades + +## Demo-first assets Use these files to create a polished first impression: - `docs/demo-assets.md` - `docs/demo-script.md` +- `docs/real-demo-playbook.md` - `docs/recipes-gallery.md` - `assets/hero-banner.svg` - `assets/terminal-demo.svg` @@ -90,17 +122,10 @@ Fastest value demos: - `recipes/invoice-reminder.md` - `recipes/ai-lead-enrichment.md` - `recipes/slack-to-notion-triage.md` +- `recipes/customer-support-escalation.md` +- `recipes/hubspot-to-slack-qualification.md` -## Example prompt - -```text -Build me an n8n workflow that watches a Gmail inbox for invoices, -saves PDF attachments to Google Drive, extracts key fields, -logs them to a spreadsheet, and posts failures to Slack. -Use safe defaults and ask only critical missing questions. -``` - -## Launch assets and publishing +## Publish-ready extras This repo includes launch materials for a public release: @@ -117,6 +142,7 @@ See: - `docs/launch-assets.md` - `docs/launch-day-checklist.md` - `docs/tutorial-subir-github.md` +- `docs/readme-premium-checklist.md` ## Suggested launch stack @@ -130,7 +156,7 @@ For the first public version, ship with: ## Roadmap -Current release line: `0.6.0` +Current release line: `0.7.0` Planned improvements include: @@ -149,6 +175,16 @@ See `docs/roadmap.md`. Crie workflows completos no n8n via MCP com qualquer agente de código. Descreva o objetivo, deixe o agente planejar, construir, validar e devolver uma automação utilizável. +**Geração de workflows no n8n com foco em planejamento, pronta para Codex, Claude Code, OpenCode e outros clientes MCP.** + +## O que você recebe + +- um **system prompt** prático para geração de workflows com planejamento prévio +- um **contrato de conversa** para discovery curto e útil +- um **schema de plano** normalizado antes da construção +- exemplos de configuração para **Codex**, **Claude Code** e **OpenCode** +- **recipes**, visuais, copy de lançamento e assets para vitrine + ## Por que esse projeto existe A maioria das pessoas não quer montar JSON na unha, decorar detalhes de nodes ou descobrir cada exceção antes do primeiro teste. Elas querem explicar o que precisam e deixar o agente fazer a parte pesada. @@ -161,21 +197,7 @@ O Vibeflow n8n é um kit open source orientado a skill para agentes e CLIs com s - validar a construção antes da entrega - reportar suposições, lacunas e próximos passos com clareza -## Clientes suportados - -Alvos documentados oficialmente neste repositório: - -- Codex CLI -- Claude Code -- OpenCode - -Compatibilidade experimental ou comunitária: - -- OpenClaude e forks semelhantes com suporte a MCP - -## O que a skill faz - -A skill segue um ciclo simples de cinco etapas: +## O fluxo da skill 1. Entende o objetivo do workflow 2. Pergunta apenas o que muda a implementação @@ -198,6 +220,7 @@ Comece por aqui: - `docs/install.md` - `templates/system-prompt.md` - `docs/conversation-contract.md` +- `schemas/plan.schema.json` ## Demonstração e vitrine @@ -205,6 +228,7 @@ Arquivos para montar uma landing page forte dentro do próprio README: - `docs/demo-assets.md` - `docs/demo-script.md` +- `docs/real-demo-playbook.md` - `docs/recipes-gallery.md` - `assets/hero-banner.svg` - `assets/terminal-demo.svg` @@ -218,34 +242,5 @@ Arquivos para montar uma landing page forte dentro do próprio README: - `recipes/invoice-reminder.md` - `recipes/ai-lead-enrichment.md` - `recipes/slack-to-notion-triage.md` - -## Exemplo de pedido - -```text -Crie um workflow no n8n que monitore um inbox de Gmail para notas fiscais, -salve anexos PDF no Google Drive, extraia campos principais, -registre tudo em uma planilha e envie falhas para o Slack. -Use defaults seguros e pergunte só o que for crítico. -``` - -## Publicação no GitHub - -Este repositório já inclui material para lançamento: - -- sugestões de descrição e tagline -- template de release notes -- checklist de lançamento -- ideias de copy para divulgação -- templates de issues e PRs -- docs de onboarding para comunidade - -Veja: - -- `docs/github-launch.md` -- `docs/launch-assets.md` -- `docs/launch-day-checklist.md` -- `docs/tutorial-subir-github.md` - -## Licença - -Consulte `LICENSE`. +- `recipes/customer-support-escalation.md` +- `recipes/hubspot-to-slack-qualification.md` diff --git a/VERSION b/VERSION index a918a2a..faef31a 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.6.0 +0.7.0 diff --git a/docs/readme-premium-checklist.md b/docs/readme-premium-checklist.md new file mode 100644 index 0000000..661c96a --- /dev/null +++ b/docs/readme-premium-checklist.md @@ -0,0 +1,38 @@ +# README Premium Checklist + +Use this before publishing a release or sharing the repository publicly. + +## Above the fold + +- project name is clear +- one-line value proposition is strong +- target users are obvious +- at least one visual asset appears early + +## Conversion layer + +- quick start is visible without excessive scrolling +- supported clients are easy to spot +- top recipes are linked directly +- install docs are linked directly + +## Trust layer + +- changelog is up to date +- security and contributing docs exist +- examples are easy to find +- roadmap is honest and short + +## Showcase layer + +- hero banner present +- at least one terminal or workflow visual +- demo script exists +- at least three recipes are public-facing and polished + +## Launch polish + +- release version updated +- launch copy updated +- repo description matches README +- social preview ready diff --git a/docs/real-demo-playbook.md b/docs/real-demo-playbook.md new file mode 100644 index 0000000..c025350 --- /dev/null +++ b/docs/real-demo-playbook.md @@ -0,0 +1,59 @@ +# Real Demo Playbook + +Use this playbook when you want a real, credible public demo instead of a static repository tour. + +## Goal + +Show a full path from plain-English request to final n8n workflow handoff in less than five minutes. + +## Suggested demo storyline + +1. Start in the terminal with a connected MCP-capable client. +2. Paste a short brief with one trigger, one transformation, and one notification path. +3. Let the agent ask only one to three critical follow-up questions. +4. Show the normalized plan before the build happens. +5. Switch to n8n and show the created workflow. +6. End with the final implementation report. + +## Best demo characteristics + +- one trigger +- two to five core nodes +- one error path +- one obvious business outcome +- one missing credential called out cleanly + +## Good public demo candidates + +- support triage to Slack +- invoice reminder workflow +- lead enrichment with CRM update +- Slack to Notion intake sorter + +## What to avoid + +- giant workflows with many credentials +- fragile scraping flows +- binary-heavy flows for the first public demo +- human approval loops during the live build +- anything that needs ten minutes of setup before value appears + +## Demo capture checklist + +- terminal font large enough to read in social clips +- n8n canvas zoom at readable level +- one file or pane open with the implementation report +- timestamps or release tags hidden if they look messy +- fake or test credentials only + +## Suggested timing + +- 30s context +- 60s planning +- 90s build +- 45s n8n review +- 30s final report and next steps + +## Closing line + +"Describe the workflow. The agent asks only what matters, builds via MCP, and hands back something usable." diff --git a/docs/release-v0.7.0.md b/docs/release-v0.7.0.md new file mode 100644 index 0000000..a334de0 --- /dev/null +++ b/docs/release-v0.7.0.md @@ -0,0 +1,15 @@ +# Vibeflow n8n v0.7.0 + +This release focuses on public-demo readiness. + +## Highlights + +- premium README refresh +- real-demo playbook for terminal-to-n8n walkthroughs +- two new showcase recipes +- illustrative sample workflow export for safer local experimentation +- extra README quality checklist for launch polish + +## Recommended next move + +Attach real screenshots or a short GIF to make the repository feel alive on first visit. diff --git a/examples/sample-workflow-export.json b/examples/sample-workflow-export.json new file mode 100644 index 0000000..e58a638 --- /dev/null +++ b/examples/sample-workflow-export.json @@ -0,0 +1,57 @@ +{ + "name": "Vibeflow Demo - Support Escalation", + "active": false, + "meta": { + "source": "vibeflow-n8n", + "note": "Illustrative export skeleton for documentation and local experimentation." + }, + "nodes": [ + { + "id": "Webhook_1", + "name": "Incoming Ticket", + "type": "n8n-nodes-base.webhook", + "position": [260, 280], + "parameters": { + "path": "support-escalation-demo", + "httpMethod": "POST" + } + }, + { + "id": "Set_1", + "name": "Normalize Payload", + "type": "n8n-nodes-base.set", + "position": [520, 280], + "parameters": { + "keepOnlySet": false, + "values": { + "string": [ + {"name": "ticket_id", "value": "={{$json.id || ''}}"}, + {"name": "priority", "value": "={{$json.priority || 'normal'}}"}, + {"name": "summary", "value": "={{$json.summary || ''}}"} + ] + } + } + }, + { + "id": "If_1", + "name": "Urgent?", + "type": "n8n-nodes-base.if", + "position": [780, 280], + "parameters": { + "conditions": { + "string": [ + {"value1": "={{$json.priority}}", "operation": "equal", "value2": "high"} + ] + } + } + } + ], + "connections": { + "Incoming Ticket": { + "main": [[{"node": "Normalize Payload", "type": "main", "index": 0}]] + }, + "Normalize Payload": { + "main": [[{"node": "Urgent?", "type": "main", "index": 0}]] + } + } +} diff --git a/recipes/customer-support-escalation.md b/recipes/customer-support-escalation.md new file mode 100644 index 0000000..3e6f0a0 --- /dev/null +++ b/recipes/customer-support-escalation.md @@ -0,0 +1,35 @@ +# Recipe: Customer Support Escalation + +## Goal + +Create an n8n workflow that watches a support inbox or helpdesk webhook, detects priority signals, enriches the ticket context, and escalates high-risk items to Slack with a clear summary. + +## Why it demos well + +- obvious business value +- clear trigger and escalation outcome +- easy to explain in less than two minutes +- one branch can demonstrate prioritization logic + +## Suggested steps + +1. Trigger from webhook or helpdesk event +2. Normalize ticket payload +3. Score urgency using rules or an LLM step +4. Route high-priority items to Slack +5. Log normal-priority items to a sheet or database +6. Add error notifications + +## Critical questions + +- What tool sends the ticket event? +- What counts as urgent? +- Who should receive escalations? +- Should every item be logged, or only urgent ones? + +## Safe defaults + +- urgency based on keywords, SLA breach flag, and VIP marker +- Slack notification for high priority only +- spreadsheet log for all processed tickets +- retry once before failure alert diff --git a/recipes/hubspot-to-slack-qualification.md b/recipes/hubspot-to-slack-qualification.md new file mode 100644 index 0000000..34b0b80 --- /dev/null +++ b/recipes/hubspot-to-slack-qualification.md @@ -0,0 +1,34 @@ +# Recipe: HubSpot to Slack Qualification + +## Goal + +Create an n8n workflow that listens for new or updated HubSpot leads, evaluates qualification rules, and sends only promising leads to Slack with a concise summary. + +## Why it demos well + +- popular stack +- simple trigger, filter, and notification pattern +- easy to narrate as a sales ops use case + +## Suggested steps + +1. Trigger on lead created or updated +2. Map company, role, source, and score fields +3. Apply qualification rules +4. Send qualified leads to Slack +5. Log non-qualified leads for later review +6. Emit failure alerts when processing breaks + +## Critical questions + +- Which HubSpot event should trigger the flow? +- What rules define a qualified lead? +- What Slack channel should receive alerts? +- Should the workflow update HubSpot properties too? + +## Safe defaults + +- qualify by score threshold and role/company fit +- send concise Slack message with source and score +- log rejected leads to a review table +- leave CRM write-back optional