mirror of
https://github.com/domfelipe/vibeflow-n8n.git
synced 2026-08-07 07:36:46 +00:00
feat: release Vibeflow n8n v0.6.0
This commit is contained in:
Felipe Domingues
parent
097f35215f
commit
260d447f40
15 changed files with 435 additions and 56 deletions
|
|
@ -4,7 +4,10 @@ Use this document to prepare screenshots, terminal captures, and visual assets f
|
|||
|
||||
## Recommended visuals
|
||||
|
||||
### 1. Terminal intake flow
|
||||
### 1. Hero banner
|
||||
Use `assets/hero-banner.svg` as a temporary visual until you capture a real workflow screenshot.
|
||||
|
||||
### 2. Terminal intake flow
|
||||
Show the agent asking for:
|
||||
- the workflow goal
|
||||
- trigger type
|
||||
|
|
@ -12,21 +15,22 @@ Show the agent asking for:
|
|||
- final action
|
||||
- exceptions or approvals
|
||||
|
||||
### 2. Plan output
|
||||
### 3. Plan output
|
||||
Capture the normalized plan before the build starts.
|
||||
|
||||
### 3. Build confirmation
|
||||
Show the agent summarizing what it created inside n8n.
|
||||
|
||||
### 4. n8n workflow canvas
|
||||
Capture the resulting workflow with readable node names.
|
||||
### 4. Workflow canvas
|
||||
Use `assets/workflow-demo.svg` as a placeholder, or replace it with a real n8n screenshot.
|
||||
|
||||
### 5. Final handoff report
|
||||
Show the concise report listing:
|
||||
- what was created
|
||||
- assumptions used
|
||||
- missing credentials
|
||||
- test steps
|
||||
Use `assets/final-report-demo.svg` as a placeholder, or capture a real final report from the agent.
|
||||
|
||||
## Included placeholder assets
|
||||
|
||||
- `assets/hero-banner.svg`
|
||||
- `assets/terminal-demo.svg`
|
||||
- `assets/workflow-demo.svg`
|
||||
- `assets/final-report-demo.svg`
|
||||
- `assets/social-preview.svg`
|
||||
|
||||
## Capture tips
|
||||
|
||||
|
|
@ -34,12 +38,7 @@ Show the concise report listing:
|
|||
- use short examples with familiar tools like Slack, Airtable, Gmail, HubSpot
|
||||
- prefer light, readable terminal themes
|
||||
- crop screenshots tightly
|
||||
- keep filenames predictable, for example:
|
||||
- `demo-intake.png`
|
||||
- `demo-plan.png`
|
||||
- `demo-build.png`
|
||||
- `demo-workflow.png`
|
||||
- `demo-report.png`
|
||||
- keep filenames predictable
|
||||
|
||||
## Suggested README image order
|
||||
|
||||
|
|
|
|||
64
docs/demo-script.md
Normal file
64
docs/demo-script.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
# Demo Script
|
||||
|
||||
Use this script to record a short terminal demo, GIF, or narrated walkthrough.
|
||||
|
||||
## Goal
|
||||
|
||||
Show that Vibeflow n8n turns a plain-language request into a structured plan and a workflow build process.
|
||||
|
||||
## Recommended demo length
|
||||
|
||||
- 30 to 60 seconds for a GIF
|
||||
- 90 to 180 seconds for a narrated video
|
||||
|
||||
## Suggested scenario
|
||||
|
||||
"Build an n8n workflow that watches Slack mentions, creates a triage page in Notion, alerts the ops channel for urgent items, and stores a summary for later reporting."
|
||||
|
||||
## Demo sequence
|
||||
|
||||
### 1. Open the repo
|
||||
Show the key files:
|
||||
- `templates/system-prompt.md`
|
||||
- `docs/conversation-contract.md`
|
||||
- `recipes/slack-to-notion-triage.md`
|
||||
|
||||
### 2. Start the agent
|
||||
Show the agent receiving a natural-language request.
|
||||
|
||||
### 3. Intake questions
|
||||
Capture a short question set such as:
|
||||
- Which Slack channel or mention pattern should trigger the workflow?
|
||||
- What counts as urgent?
|
||||
- What Notion database should receive the item?
|
||||
- Should failures notify Slack or email?
|
||||
|
||||
### 4. Plan output
|
||||
Show the normalized plan with these visible sections:
|
||||
- objective
|
||||
- trigger
|
||||
- steps
|
||||
- branching logic
|
||||
- credentials needed
|
||||
- validation plan
|
||||
|
||||
### 5. Build handoff
|
||||
Show the agent summarizing what it is about to create in n8n.
|
||||
|
||||
### 6. Workflow view
|
||||
Capture the n8n canvas or a placeholder workflow image.
|
||||
|
||||
### 7. Final report
|
||||
Show a concise final handoff report listing:
|
||||
- what was created
|
||||
- assumptions used
|
||||
- missing credentials
|
||||
- how to test it
|
||||
|
||||
## Recording tips
|
||||
|
||||
- keep the terminal font large
|
||||
- hide secrets and account names
|
||||
- use a short but realistic workflow request
|
||||
- crop tightly and avoid idle pauses
|
||||
- prefer one clean storyline over many cuts
|
||||
58
docs/recipes-gallery.md
Normal file
58
docs/recipes-gallery.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
# Recipes Gallery
|
||||
|
||||
Use this page to choose the strongest recipes for screenshots, demos, and first-run adoption.
|
||||
|
||||
## Recommended hero recipes
|
||||
|
||||
### 1. Lead Triage
|
||||
Best for showing business routing, safe defaults, and clean branching.
|
||||
|
||||
Use when you want to demonstrate:
|
||||
- form or CRM intake
|
||||
- qualification logic
|
||||
- routing to a sales queue
|
||||
- notifications to Slack or email
|
||||
|
||||
### 2. Support Triage
|
||||
Best for showing operational workflows with urgency rules.
|
||||
|
||||
Use when you want to demonstrate:
|
||||
- inbound support intake
|
||||
- priority detection
|
||||
- response classification
|
||||
- escalation paths
|
||||
|
||||
### 3. Invoice Reminder
|
||||
Best for finance or back-office audiences.
|
||||
|
||||
Use when you want to demonstrate:
|
||||
- schedule triggers
|
||||
- spreadsheet or database lookups
|
||||
- reminder logic
|
||||
- retry and failure handling
|
||||
|
||||
### 4. AI Lead Enrichment
|
||||
Best for showing AI-assisted steps without becoming overly abstract.
|
||||
|
||||
Use when you want to demonstrate:
|
||||
- enrichment APIs
|
||||
- summary generation
|
||||
- structured output fields
|
||||
- CRM updates
|
||||
|
||||
### 5. Slack to Notion Triage
|
||||
Best for showing a workflow that feels modern and concrete in demos.
|
||||
|
||||
Use when you want to demonstrate:
|
||||
- Slack triggers
|
||||
- content normalization
|
||||
- Notion inserts
|
||||
- urgent routing and summaries
|
||||
|
||||
## Suggested README order
|
||||
|
||||
1. Slack to Notion Triage
|
||||
2. AI Lead Enrichment
|
||||
3. Invoice Reminder
|
||||
|
||||
This sequence shows speed, intelligence, and operational depth.
|
||||
|
|
@ -1,28 +1,28 @@
|
|||
# Roadmap
|
||||
|
||||
## Current state: v0.3.0
|
||||
## Current state: v0.6.0
|
||||
|
||||
V3 is designed to be GitHub-ready:
|
||||
- documentation is stronger
|
||||
- client setup is more concrete
|
||||
- a normalized plan schema exists
|
||||
- examples are easier to adapt
|
||||
- release flow is clearer
|
||||
V6 is designed to be showcase-ready:
|
||||
- launch and community docs are in place
|
||||
- client snippets are documented
|
||||
- normalized plan schema exists
|
||||
- demo-oriented recipes are stronger
|
||||
- placeholder visual assets are included for the first public version
|
||||
|
||||
## v0.4.0 ideas
|
||||
## v0.7.0 ideas
|
||||
|
||||
- richer sample plans across domains
|
||||
- optional validation checklist by workflow type
|
||||
- repository screenshots and terminal captures
|
||||
- sample `.mcp.json`, `config.toml`, and `opencode.jsonc` fixtures
|
||||
- stricter final report format
|
||||
- sample workflow exports for safe local testing
|
||||
- richer setup fixtures by client
|
||||
- validation helper scripts for plan payloads
|
||||
- GIFs and screenshots from real runs
|
||||
- recipe packs for sales, support, finance, and internal ops
|
||||
|
||||
## v0.5.0 ideas
|
||||
## v0.8.0 ideas
|
||||
|
||||
- test harness for plan validation
|
||||
- library of domain-specific recipes
|
||||
- template packs for lead ops, support ops, finance ops, and AI agents
|
||||
- optional workflow quality scoring rubric
|
||||
- optional plan linter
|
||||
- workflow quality checklist by recipe type
|
||||
- starter gallery page for examples
|
||||
- benchmark prompts for comparing clients
|
||||
|
||||
## Long-term direction
|
||||
|
||||
|
|
@ -31,3 +31,4 @@ Turn Vibeflow n8n into a portable skill pack that:
|
|||
- plans before building
|
||||
- works across multiple MCP-capable coding agents
|
||||
- remains understandable to non-experts
|
||||
- feels demo-friendly from the first clone
|
||||
|
|
|
|||
30
docs/showcase-checklist.md
Normal file
30
docs/showcase-checklist.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Showcase Checklist
|
||||
|
||||
Use this checklist before sharing the repo publicly.
|
||||
|
||||
## README
|
||||
- clear one-line value proposition
|
||||
- 1 hero visual near the top
|
||||
- 1 example prompt
|
||||
- 3 highlighted recipes
|
||||
- quick-start links visible without scrolling too far
|
||||
|
||||
## Assets
|
||||
- hero banner present
|
||||
- social preview present
|
||||
- at least 3 demo visuals present
|
||||
- filenames are simple and predictable
|
||||
|
||||
## Recipes
|
||||
- at least 3 recipes feel production-adjacent
|
||||
- every recipe includes trigger, steps, assumptions, and test plan
|
||||
- one recipe includes AI enrichment
|
||||
- one recipe includes support or ops logic
|
||||
- one recipe includes finance logic
|
||||
|
||||
## Release
|
||||
- VERSION bumped
|
||||
- CHANGELOG updated
|
||||
- GitHub release notes drafted
|
||||
- topics and description ready
|
||||
- first screenshot or GIF attached
|
||||
Loading…
Add table
Add a link
Reference in a new issue