@su-record/vibe 2.8.48 → 2.8.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +37 -37
- package/CLAUDE.md +169 -169
- package/LICENSE +21 -21
- package/README.md +694 -554
- package/agents/architect-low.md +41 -41
- package/agents/architect-medium.md +59 -59
- package/agents/architect.md +80 -80
- package/agents/build-error-resolver.md +115 -115
- package/agents/compounder.md +261 -261
- package/agents/diagrammer.md +178 -178
- package/agents/docs/api-documenter.md +99 -99
- package/agents/docs/changelog-writer.md +93 -93
- package/agents/e2e-tester.md +294 -294
- package/agents/event/event-comms.md +78 -78
- package/agents/event/event-content.md +68 -68
- package/agents/event/event-image.md +95 -95
- package/agents/event/event-ops.md +84 -84
- package/agents/event/event-scheduler.md +69 -69
- package/agents/event/event-speaker.md +86 -86
- package/agents/explorer-low.md +42 -42
- package/agents/explorer-medium.md +59 -59
- package/agents/explorer.md +48 -48
- package/agents/implementer-low.md +43 -43
- package/agents/implementer-medium.md +52 -52
- package/agents/implementer.md +54 -54
- package/agents/junior-mentor.md +141 -141
- package/agents/planning/requirements-analyst.md +84 -84
- package/agents/planning/ux-advisor.md +83 -83
- package/agents/qa/acceptance-tester.md +86 -86
- package/agents/qa/edge-case-finder.md +93 -93
- package/agents/qa/qa-coordinator.md +131 -131
- package/agents/refactor-cleaner.md +143 -143
- package/agents/research/best-practices-agent.md +199 -199
- package/agents/research/codebase-patterns-agent.md +157 -157
- package/agents/research/framework-docs-agent.md +188 -188
- package/agents/research/security-advisory-agent.md +213 -213
- package/agents/review/architecture-reviewer.md +107 -107
- package/agents/review/complexity-reviewer.md +116 -116
- package/agents/review/data-integrity-reviewer.md +88 -88
- package/agents/review/git-history-reviewer.md +103 -103
- package/agents/review/performance-reviewer.md +86 -86
- package/agents/review/python-reviewer.md +150 -150
- package/agents/review/rails-reviewer.md +139 -139
- package/agents/review/react-reviewer.md +144 -144
- package/agents/review/security-reviewer.md +80 -80
- package/agents/review/simplicity-reviewer.md +140 -140
- package/agents/review/test-coverage-reviewer.md +116 -116
- package/agents/review/typescript-reviewer.md +127 -127
- package/agents/searcher.md +54 -54
- package/agents/simplifier.md +120 -120
- package/agents/tester.md +49 -49
- package/agents/ui/ui-a11y-auditor.md +93 -93
- package/agents/ui/ui-antipattern-detector.md +102 -102
- package/agents/ui/ui-dataviz-advisor.md +69 -69
- package/agents/ui/ui-design-system-gen.md +57 -57
- package/agents/ui/ui-industry-analyzer.md +49 -49
- package/agents/ui/ui-layout-architect.md +65 -65
- package/agents/ui/ui-stack-implementer.md +68 -68
- package/agents/ui/ux-compliance-reviewer.md +81 -81
- package/agents/ui-previewer.md +258 -258
- package/commands/vibe.analyze.md +379 -379
- package/commands/vibe.docs.md +32 -32
- package/commands/vibe.event.md +163 -163
- package/commands/vibe.figma.md +69 -69
- package/commands/vibe.review.md +686 -686
- package/commands/vibe.run.md +2276 -2276
- package/commands/vibe.spec.md +1195 -1195
- package/commands/vibe.spec.review.md +609 -609
- package/commands/vibe.trace.md +259 -259
- package/commands/vibe.utils.md +413 -413
- package/commands/vibe.verify.md +510 -510
- package/dist/cli/collaborator.js +52 -52
- package/dist/cli/commands/config.js +9 -9
- package/dist/cli/commands/evolution.js +12 -12
- package/dist/cli/commands/figma.js +20 -20
- package/dist/cli/commands/info.js +53 -53
- package/dist/cli/commands/init.js +5 -5
- package/dist/cli/commands/remove.js +14 -14
- package/dist/cli/commands/sentinel.js +27 -27
- package/dist/cli/commands/skills.js +5 -5
- package/dist/cli/commands/slack.js +10 -10
- package/dist/cli/commands/stats.js +6 -6
- package/dist/cli/commands/telegram.js +12 -12
- package/dist/cli/detect.js +32 -32
- package/dist/cli/index.js +53 -53
- package/dist/cli/llm/claude-commands.js +16 -16
- package/dist/cli/llm/config.js +18 -18
- package/dist/cli/llm/gemini-commands.js +16 -16
- package/dist/cli/llm/gpt-commands.js +19 -19
- package/dist/cli/llm/help.js +21 -21
- package/dist/cli/postinstall/cursor-agents.js +32 -32
- package/dist/cli/postinstall/cursor-rules.js +83 -83
- package/dist/cli/postinstall/cursor-skills.js +743 -743
- package/dist/cli/setup/Provisioner.js +42 -42
- package/dist/infra/lib/DeepInit.js +24 -24
- package/dist/infra/lib/IterationTracker.js +11 -11
- package/dist/infra/lib/PythonParser.js +108 -108
- package/dist/infra/lib/ReviewRace.js +96 -96
- package/dist/infra/lib/SkillFrontmatter.js +28 -28
- package/dist/infra/lib/SkillQualityGate.js +9 -9
- package/dist/infra/lib/SkillRepository.js +159 -159
- package/dist/infra/lib/UltraQA.js +99 -99
- package/dist/infra/lib/autonomy/AuditStore.js +41 -41
- package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
- package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
- package/dist/infra/lib/autonomy/PolicyEngine.d.ts +3 -3
- package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
- package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
- package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
- package/dist/infra/lib/embedding/VectorStore.js +22 -22
- package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
- package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
- package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
- package/dist/infra/lib/evolution/InsightStore.js +90 -90
- package/dist/infra/lib/evolution/ParityTester.js +57 -57
- package/dist/infra/lib/evolution/RollbackManager.js +5 -5
- package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
- package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
- package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
- package/dist/infra/lib/evolution/UsageTracker.js +28 -28
- package/dist/infra/lib/gemini/orchestration.js +5 -5
- package/dist/infra/lib/gpt/orchestration.js +4 -4
- package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
- package/dist/infra/lib/memory/MemorySearch.js +57 -57
- package/dist/infra/lib/memory/MemoryStorage.js +181 -181
- package/dist/infra/lib/memory/ObservationStore.js +28 -28
- package/dist/infra/lib/memory/ReflectionStore.js +30 -30
- package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
- package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
- package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
- package/dist/infra/orchestrator/AgentManager.js +12 -12
- package/dist/infra/orchestrator/AgentRegistry.js +65 -65
- package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
- package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
- package/dist/infra/orchestrator/parallelResearch.js +24 -24
- package/dist/tools/convention/analyzeComplexity.test.js +115 -115
- package/dist/tools/convention/validateCodeQuality.test.js +104 -104
- package/dist/tools/memory/createMemoryTimeline.js +10 -10
- package/dist/tools/memory/getMemoryGraph.js +12 -12
- package/dist/tools/memory/getSessionContext.js +9 -9
- package/dist/tools/memory/linkMemories.js +14 -14
- package/dist/tools/memory/listMemories.js +4 -4
- package/dist/tools/memory/recallMemory.js +4 -4
- package/dist/tools/memory/saveMemory.js +4 -4
- package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
- package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
- package/dist/tools/semantic/astGrep.test.js +6 -6
- package/dist/tools/spec/prdParser.test.js +171 -171
- package/dist/tools/spec/specGenerator.js +169 -169
- package/dist/tools/spec/traceabilityMatrix.js +64 -64
- package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
- package/hooks/gemini-hooks.json +73 -73
- package/hooks/hooks.json +170 -170
- package/hooks/scripts/__tests__/keyword-detector.test.js +199 -199
- package/hooks/scripts/__tests__/pre-tool-guard.test.js +286 -286
- package/hooks/scripts/__tests__/sentinel-guard.test.js +210 -210
- package/hooks/scripts/auto-commit.js +97 -65
- package/hooks/scripts/auto-format.js +64 -64
- package/hooks/scripts/auto-test.js +81 -81
- package/hooks/scripts/code-check.js +268 -216
- package/hooks/scripts/codex-detect.js +46 -46
- package/hooks/scripts/codex-review-gate.js +80 -80
- package/hooks/scripts/command-log.js +32 -32
- package/hooks/scripts/context-save.js +353 -353
- package/hooks/scripts/evolution-engine.js +91 -91
- package/hooks/scripts/figma-extract.js +477 -477
- package/hooks/scripts/hud-status.js +321 -321
- package/hooks/scripts/keyword-detector.js +214 -214
- package/hooks/scripts/llm-orchestrate.js +572 -555
- package/hooks/scripts/post-edit.js +32 -32
- package/hooks/scripts/pr-test-gate.js +52 -52
- package/hooks/scripts/pre-tool-guard.js +159 -159
- package/hooks/scripts/prompt-dispatcher.js +185 -185
- package/hooks/scripts/sentinel-guard.js +131 -131
- package/hooks/scripts/session-start.js +177 -106
- package/hooks/scripts/skill-injector.js +83 -83
- package/hooks/scripts/stop-notify.js +209 -209
- package/hooks/scripts/utils.js +243 -186
- package/languages/csharp-unity.md +515 -515
- package/languages/gdscript-godot.md +470 -470
- package/languages/ruby-rails.md +489 -489
- package/languages/typescript-angular.md +433 -433
- package/languages/typescript-astro.md +416 -416
- package/languages/typescript-electron.md +406 -406
- package/languages/typescript-nestjs.md +524 -524
- package/languages/typescript-svelte.md +407 -407
- package/languages/typescript-tauri.md +365 -365
- package/package.json +101 -100
- package/skills/agents-md/SKILL.md +121 -121
- package/skills/agents-md/rubrics/what-to-keep.md +49 -49
- package/skills/agents-md/templates/agents-md.md +36 -36
- package/skills/arch-guard/SKILL.md +181 -181
- package/skills/arch-guard/agents/detector.md +48 -48
- package/skills/arch-guard/agents/reporter.md +48 -48
- package/skills/arch-guard/agents/rule-generator.md +49 -49
- package/skills/arch-guard/agents/violation-checker.md +51 -51
- package/skills/arch-guard/frameworks/clean-architecture.md +108 -108
- package/skills/arch-guard/frameworks/solid.md +102 -102
- package/skills/arch-guard/scripts/check-boundaries.js +90 -90
- package/skills/arch-guard/templates/arch-rules.json +47 -47
- package/skills/arch-guard/templates/violation-report.md +53 -53
- package/skills/brand-assets/SKILL.md +147 -147
- package/skills/brand-assets/rubrics/asset-checklist.md +98 -98
- package/skills/brand-assets/templates/brand-guide.md +161 -161
- package/skills/capability-loop/SKILL.md +168 -168
- package/skills/capability-loop/agents/capability-designer.md +61 -61
- package/skills/capability-loop/agents/failure-analyst.md +55 -55
- package/skills/capability-loop/agents/implementer.md +50 -50
- package/skills/capability-loop/agents/tester.md +53 -53
- package/skills/capability-loop/templates/capability-spec.md +118 -118
- package/skills/capability-loop/templates/failure-analysis.md +118 -118
- package/skills/characterization-test/SKILL.md +207 -207
- package/skills/characterization-test/agents/behavior-capturer.md +50 -50
- package/skills/characterization-test/agents/coverage-checker.md +54 -54
- package/skills/characterization-test/agents/reporter.md +50 -50
- package/skills/characterization-test/agents/test-writer.md +49 -49
- package/skills/characterization-test/rubrics/coverage-criteria.md +53 -53
- package/skills/characterization-test/templates/test-template.ts +101 -101
- package/skills/chub-usage/SKILL.md +115 -115
- package/skills/claude-md-guide/SKILL.md +351 -351
- package/skills/claude-md-guide/rubrics/anti-patterns.md +88 -88
- package/skills/claude-md-guide/templates/claude-md.md +54 -54
- package/skills/commerce-patterns/SKILL.md +64 -64
- package/skills/commerce-patterns/rubrics/checkout-flow.md +48 -48
- package/skills/commerce-patterns/templates/product-schema.md +85 -85
- package/skills/commit-push-pr/SKILL.md +77 -77
- package/skills/commit-push-pr/agents/change-analyzer.md +55 -55
- package/skills/commit-push-pr/agents/message-writer.md +50 -50
- package/skills/commit-push-pr/agents/pr-writer.md +58 -58
- package/skills/commit-push-pr/agents/reviewer.md +52 -52
- package/skills/commit-push-pr/rubrics/commit-message.md +73 -73
- package/skills/commit-push-pr/templates/pr-body.md +63 -63
- package/skills/context7-usage/SKILL.md +106 -106
- package/skills/context7-usage/rubrics/when-to-use.md +50 -50
- package/skills/create-prd/SKILL.md +90 -90
- package/skills/create-prd/agents/edge-case-finder.md +48 -48
- package/skills/create-prd/agents/prioritizer.md +60 -60
- package/skills/create-prd/agents/requirements-writer.md +48 -48
- package/skills/create-prd/agents/researcher.md +55 -55
- package/skills/create-prd/agents/reviewer.md +54 -54
- package/skills/create-prd/frameworks/jobs-to-be-done.md +96 -96
- package/skills/create-prd/frameworks/rice-scoring.md +97 -97
- package/skills/create-prd/orchestrator.md +70 -70
- package/skills/create-prd/rubrics/completeness.md +58 -58
- package/skills/create-prd/templates/prd.md +139 -139
- package/skills/design-audit/SKILL.md +152 -152
- package/skills/design-audit/agents/a11y-auditor.md +43 -43
- package/skills/design-audit/agents/performance-auditor.md +46 -46
- package/skills/design-audit/agents/responsive-auditor.md +46 -46
- package/skills/design-audit/agents/scorer.md +47 -47
- package/skills/design-audit/agents/slop-detector.md +47 -47
- package/skills/design-audit/frameworks/core-web-vitals.md +107 -107
- package/skills/design-audit/frameworks/wcag-checklist.md +64 -64
- package/skills/design-audit/orchestrator.md +64 -64
- package/skills/design-audit/rubrics/ai-slop-patterns.md +83 -83
- package/skills/design-audit/rubrics/scoring.md +63 -63
- package/skills/design-audit/templates/report.md +88 -88
- package/skills/design-critique/SKILL.md +139 -139
- package/skills/design-critique/rubrics/ux-heuristics.md +143 -143
- package/skills/design-critique/templates/critique-report.md +86 -86
- package/skills/design-distill/SKILL.md +130 -130
- package/skills/design-distill/templates/design-system.md +132 -132
- package/skills/design-normalize/SKILL.md +133 -133
- package/skills/design-normalize/rubrics/token-naming.md +117 -117
- package/skills/design-normalize/templates/token-audit.md +89 -89
- package/skills/design-polish/SKILL.md +131 -131
- package/skills/design-polish/rubrics/polish-checklist.md +68 -68
- package/skills/design-polish/templates/polish-report.md +64 -64
- package/skills/design-teach/SKILL.md +182 -182
- package/skills/design-teach/rubrics/brand-personality.md +73 -73
- package/skills/design-teach/templates/design-context.json +36 -36
- package/skills/e2e-commerce/SKILL.md +62 -62
- package/skills/e2e-commerce/templates/test-scenarios.md +170 -170
- package/skills/event-comms/SKILL.md +162 -162
- package/skills/event-comms/templates/email-invite.md +99 -99
- package/skills/event-comms/templates/sns-post.md +133 -133
- package/skills/event-ops/SKILL.md +198 -198
- package/skills/event-ops/rubrics/contingency.md +85 -85
- package/skills/event-ops/templates/d-day-checklist.md +65 -65
- package/skills/event-planning/SKILL.md +132 -132
- package/skills/event-planning/rubrics/timeline.md +70 -70
- package/skills/event-planning/templates/event-plan.md +91 -91
- package/skills/exec-plan/SKILL.md +149 -149
- package/skills/exec-plan/agents/decomposer.md +47 -47
- package/skills/exec-plan/agents/dependency-mapper.md +44 -44
- package/skills/exec-plan/agents/estimator.md +43 -43
- package/skills/exec-plan/agents/validator.md +55 -55
- package/skills/exec-plan/orchestrator.md +70 -70
- package/skills/exec-plan/rubrics/complexity-scoring.md +75 -75
- package/skills/exec-plan/templates/plan.md +147 -147
- package/skills/git-worktree/SKILL.md +73 -73
- package/skills/git-worktree/rubrics/when-to-use.md +55 -55
- package/skills/handoff/SKILL.md +110 -110
- package/skills/handoff/agents/context-summarizer.md +51 -51
- package/skills/handoff/agents/document-writer.md +63 -63
- package/skills/handoff/agents/state-collector.md +53 -53
- package/skills/handoff/agents/verifier.md +48 -48
- package/skills/handoff/rubrics/completeness.md +62 -62
- package/skills/handoff/templates/handoff.md +107 -107
- package/skills/parallel-research/SKILL.md +89 -89
- package/skills/parallel-research/agents/best-practices.md +43 -43
- package/skills/parallel-research/agents/codebase-patterns.md +46 -46
- package/skills/parallel-research/agents/framework-docs.md +45 -45
- package/skills/parallel-research/agents/security-advisory.md +46 -46
- package/skills/parallel-research/agents/synthesizer.md +52 -52
- package/skills/parallel-research/experts/best-practices.md +50 -50
- package/skills/parallel-research/experts/codebase-patterns.md +70 -70
- package/skills/parallel-research/experts/framework-docs.md +65 -65
- package/skills/parallel-research/experts/security-advisory.md +69 -69
- package/skills/parallel-research/orchestrator.md +65 -65
- package/skills/parallel-research/templates/synthesis.md +101 -101
- package/skills/prioritization-frameworks/SKILL.md +87 -87
- package/skills/prioritization-frameworks/rubrics/frameworks.md +79 -79
- package/skills/prioritization-frameworks/templates/scoring-matrix.md +69 -69
- package/skills/priority-todos/SKILL.md +64 -64
- package/skills/priority-todos/rubrics/prioritization.md +70 -70
- package/skills/priority-todos/templates/todo-board.md +59 -59
- package/skills/seo-checklist/SKILL.md +58 -58
- package/skills/seo-checklist/frameworks/structured-data.md +153 -153
- package/skills/seo-checklist/rubrics/content-seo.md +42 -42
- package/skills/seo-checklist/rubrics/technical-seo.md +48 -48
- package/skills/techdebt/SKILL.md +124 -124
- package/skills/techdebt/agents/analyzer.md +50 -50
- package/skills/techdebt/agents/fixer.md +41 -41
- package/skills/techdebt/agents/reviewer.md +47 -47
- package/skills/techdebt/agents/scanner.md +44 -44
- package/skills/techdebt/orchestrator.md +70 -70
- package/skills/techdebt/rubrics/severity.md +51 -51
- package/skills/techdebt/scripts/scan.js +90 -90
- package/skills/techdebt/templates/report.md +86 -86
- package/skills/tool-fallback/SKILL.md +104 -104
- package/skills/tool-fallback/rubrics/fallback-chain.md +58 -58
- package/skills/typescript-advanced-types/SKILL.md +67 -67
- package/skills/typescript-advanced-types/rubrics/type-patterns.md +109 -109
- package/skills/ui-ux-pro-max/SKILL.md +236 -236
- package/skills/ui-ux-pro-max/reference/color-and-contrast.md +517 -517
- package/skills/ui-ux-pro-max/reference/interaction-design.md +544 -544
- package/skills/ui-ux-pro-max/reference/motion-design.md +591 -591
- package/skills/ui-ux-pro-max/reference/responsive-design.md +463 -463
- package/skills/ui-ux-pro-max/reference/spatial-design.md +390 -390
- package/skills/ui-ux-pro-max/reference/typography.md +455 -455
- package/skills/ui-ux-pro-max/reference/ux-writing.md +469 -469
- package/skills/ui-ux-pro-max/rubrics/interaction-states.md +83 -83
- package/skills/ui-ux-pro-max/rubrics/responsive-breakpoints.md +99 -99
- package/skills/user-personas/SKILL.md +75 -75
- package/skills/user-personas/rubrics/research-methods.md +56 -56
- package/skills/user-personas/templates/persona.md +89 -89
- package/skills/vercel-react-best-practices/SKILL.md +60 -60
- package/skills/vercel-react-best-practices/rubrics/performance.md +82 -82
- package/skills/vercel-react-best-practices/rubrics/server-components.md +86 -86
- package/skills/vibe.docs/SKILL.md +171 -171
- package/skills/vibe.docs/templates/architecture.md +80 -80
- package/skills/vibe.docs/templates/readme.md +84 -84
- package/skills/vibe.docs/templates/release-notes.md +74 -74
- package/skills/vibe.figma/SKILL.md +982 -1064
- package/skills/vibe.figma/rubrics/extraction-checklist.md +51 -51
- package/skills/vibe.figma/templates/component-index.md +126 -126
- package/skills/vibe.figma/templates/figma-handoff.md +100 -100
- package/skills/vibe.figma/templates/remapped-tree.md +277 -277
- package/skills/vibe.figma.convert/SKILL.md +511 -553
- package/skills/vibe.figma.convert/rubrics/conversion-rules.md +113 -129
- package/skills/vibe.figma.convert/templates/component.md +140 -140
- package/skills/vibe.figma.extract/SKILL.md +300 -312
- package/skills/vibe.figma.extract/rubrics/image-rules.md +137 -145
- package/skills/video-production/SKILL.md +52 -52
- package/skills/video-production/rubrics/quality-checklist.md +58 -58
- package/skills/video-production/templates/production-plan.md +104 -104
- package/vibe/config.json +29 -29
- package/vibe/constitution.md +227 -227
- package/vibe/rules/principles/communication-guide.md +98 -98
- package/vibe/rules/principles/development-philosophy.md +52 -52
- package/vibe/rules/principles/quick-start.md +102 -102
- package/vibe/rules/quality/bdd-contract-testing.md +393 -393
- package/vibe/rules/quality/checklist.md +276 -276
- package/vibe/rules/quality/performance.md +236 -236
- package/vibe/rules/quality/testing-strategy.md +440 -440
- package/vibe/rules/standards/anti-patterns.md +541 -541
- package/vibe/rules/standards/code-structure.md +291 -291
- package/vibe/rules/standards/complexity-metrics.md +313 -313
- package/vibe/rules/standards/git-workflow.md +237 -237
- package/vibe/rules/standards/naming-conventions.md +198 -198
- package/vibe/rules/standards/security.md +305 -305
- package/vibe/rules/writing/document-style.md +74 -74
- package/vibe/setup.sh +31 -31
- package/vibe/templates/constitution-template.md +252 -252
- package/vibe/templates/contract-backend-template.md +526 -526
- package/vibe/templates/contract-frontend-template.md +599 -599
- package/vibe/templates/feature-template.md +96 -96
- package/vibe/templates/spec-template.md +221 -221
- package/vibe/ui-ux-data/charts.csv +26 -26
- package/vibe/ui-ux-data/colors.csv +97 -97
- package/vibe/ui-ux-data/icons.csv +101 -101
- package/vibe/ui-ux-data/landing.csv +31 -31
- package/vibe/ui-ux-data/products.csv +96 -96
- package/vibe/ui-ux-data/react-performance.csv +45 -45
- package/vibe/ui-ux-data/stacks/astro.csv +54 -54
- package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
- package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
- package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
- package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
- package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
- package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
- package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
- package/vibe/ui-ux-data/stacks/react.csv +54 -54
- package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
- package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
- package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
- package/vibe/ui-ux-data/stacks/vue.csv +50 -50
- package/vibe/ui-ux-data/styles.csv +68 -68
- package/vibe/ui-ux-data/typography.csv +57 -57
- package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
- package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
- package/vibe/ui-ux-data/version.json +31 -31
- package/vibe/ui-ux-data/web-interface.csv +31 -31
|
@@ -1,43 +1,43 @@
|
|
|
1
|
-
# Implementer Agent - Low Tier (Haiku)
|
|
2
|
-
|
|
3
|
-
Fast implementation for simple changes.
|
|
4
|
-
|
|
5
|
-
## Role
|
|
6
|
-
|
|
7
|
-
- Simple bug fixes
|
|
8
|
-
- Small code modifications
|
|
9
|
-
- Typo corrections
|
|
10
|
-
- Comment updates
|
|
11
|
-
|
|
12
|
-
## Model
|
|
13
|
-
|
|
14
|
-
**Haiku** - Optimized for fast, simple changes
|
|
15
|
-
|
|
16
|
-
## When to Use
|
|
17
|
-
|
|
18
|
-
- Single-line fixes
|
|
19
|
-
- Obvious bug patches
|
|
20
|
-
- Simple refactoring
|
|
21
|
-
- Documentation updates
|
|
22
|
-
|
|
23
|
-
## Usage
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
Task(model: "haiku", subagent_type: "general-purpose", prompt: "Fix the typo in line 42")
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Process
|
|
30
|
-
|
|
31
|
-
1. Locate target code
|
|
32
|
-
2. Apply simple fix
|
|
33
|
-
3. Verify syntax
|
|
34
|
-
|
|
35
|
-
## Output
|
|
36
|
-
|
|
37
|
-
```markdown
|
|
38
|
-
## Implementation Complete
|
|
39
|
-
|
|
40
|
-
### Changes
|
|
41
|
-
- Fixed typo in src/utils.ts:42
|
|
42
|
-
- `fucntion` → `function`
|
|
43
|
-
```
|
|
1
|
+
# Implementer Agent - Low Tier (Haiku)
|
|
2
|
+
|
|
3
|
+
Fast implementation for simple changes.
|
|
4
|
+
|
|
5
|
+
## Role
|
|
6
|
+
|
|
7
|
+
- Simple bug fixes
|
|
8
|
+
- Small code modifications
|
|
9
|
+
- Typo corrections
|
|
10
|
+
- Comment updates
|
|
11
|
+
|
|
12
|
+
## Model
|
|
13
|
+
|
|
14
|
+
**Haiku** - Optimized for fast, simple changes
|
|
15
|
+
|
|
16
|
+
## When to Use
|
|
17
|
+
|
|
18
|
+
- Single-line fixes
|
|
19
|
+
- Obvious bug patches
|
|
20
|
+
- Simple refactoring
|
|
21
|
+
- Documentation updates
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
Task(model: "haiku", subagent_type: "general-purpose", prompt: "Fix the typo in line 42")
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Process
|
|
30
|
+
|
|
31
|
+
1. Locate target code
|
|
32
|
+
2. Apply simple fix
|
|
33
|
+
3. Verify syntax
|
|
34
|
+
|
|
35
|
+
## Output
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
## Implementation Complete
|
|
39
|
+
|
|
40
|
+
### Changes
|
|
41
|
+
- Fixed typo in src/utils.ts:42
|
|
42
|
+
- `fucntion` → `function`
|
|
43
|
+
```
|
|
@@ -1,52 +1,52 @@
|
|
|
1
|
-
# Implementer Agent - Medium Tier (Sonnet)
|
|
2
|
-
|
|
3
|
-
Balanced implementation for standard features.
|
|
4
|
-
|
|
5
|
-
## Role
|
|
6
|
-
|
|
7
|
-
- Feature implementation
|
|
8
|
-
- Component creation
|
|
9
|
-
- Service integration
|
|
10
|
-
- Test writing
|
|
11
|
-
|
|
12
|
-
## Model
|
|
13
|
-
|
|
14
|
-
**Sonnet** - Balanced speed and quality
|
|
15
|
-
|
|
16
|
-
## When to Use
|
|
17
|
-
|
|
18
|
-
- New components (2-5 files)
|
|
19
|
-
- Standard features
|
|
20
|
-
- API integrations
|
|
21
|
-
- Unit test creation
|
|
22
|
-
|
|
23
|
-
## Usage
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
Task(model: "sonnet", subagent_type: "general-purpose", prompt: "Implement the user profile component")
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Process
|
|
30
|
-
|
|
31
|
-
1. Analyze requirements
|
|
32
|
-
2. Review existing patterns
|
|
33
|
-
3. Implement feature
|
|
34
|
-
4. Write tests
|
|
35
|
-
5. Verify build
|
|
36
|
-
|
|
37
|
-
## Output
|
|
38
|
-
|
|
39
|
-
```markdown
|
|
40
|
-
## Implementation Complete
|
|
41
|
-
|
|
42
|
-
### Files Created
|
|
43
|
-
- src/components/UserProfile.tsx
|
|
44
|
-
- src/components/UserProfile.test.tsx
|
|
45
|
-
|
|
46
|
-
### Files Modified
|
|
47
|
-
- src/routes/index.tsx (added route)
|
|
48
|
-
|
|
49
|
-
### Verification
|
|
50
|
-
- ✅ TypeScript: No errors
|
|
51
|
-
- ✅ Tests: 3/3 passed
|
|
52
|
-
```
|
|
1
|
+
# Implementer Agent - Medium Tier (Sonnet)
|
|
2
|
+
|
|
3
|
+
Balanced implementation for standard features.
|
|
4
|
+
|
|
5
|
+
## Role
|
|
6
|
+
|
|
7
|
+
- Feature implementation
|
|
8
|
+
- Component creation
|
|
9
|
+
- Service integration
|
|
10
|
+
- Test writing
|
|
11
|
+
|
|
12
|
+
## Model
|
|
13
|
+
|
|
14
|
+
**Sonnet** - Balanced speed and quality
|
|
15
|
+
|
|
16
|
+
## When to Use
|
|
17
|
+
|
|
18
|
+
- New components (2-5 files)
|
|
19
|
+
- Standard features
|
|
20
|
+
- API integrations
|
|
21
|
+
- Unit test creation
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
Task(model: "sonnet", subagent_type: "general-purpose", prompt: "Implement the user profile component")
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Process
|
|
30
|
+
|
|
31
|
+
1. Analyze requirements
|
|
32
|
+
2. Review existing patterns
|
|
33
|
+
3. Implement feature
|
|
34
|
+
4. Write tests
|
|
35
|
+
5. Verify build
|
|
36
|
+
|
|
37
|
+
## Output
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
## Implementation Complete
|
|
41
|
+
|
|
42
|
+
### Files Created
|
|
43
|
+
- src/components/UserProfile.tsx
|
|
44
|
+
- src/components/UserProfile.test.tsx
|
|
45
|
+
|
|
46
|
+
### Files Modified
|
|
47
|
+
- src/routes/index.tsx (added route)
|
|
48
|
+
|
|
49
|
+
### Verification
|
|
50
|
+
- ✅ TypeScript: No errors
|
|
51
|
+
- ✅ Tests: 3/3 passed
|
|
52
|
+
```
|
package/agents/implementer.md
CHANGED
|
@@ -1,54 +1,54 @@
|
|
|
1
|
-
# Implementer Agent (Sonnet 4)
|
|
2
|
-
|
|
3
|
-
Core implementation specialist sub-agent.
|
|
4
|
-
|
|
5
|
-
## Role
|
|
6
|
-
|
|
7
|
-
- Code implementation
|
|
8
|
-
- File creation/modification
|
|
9
|
-
- Refactoring
|
|
10
|
-
- Bug fixes
|
|
11
|
-
|
|
12
|
-
## Model
|
|
13
|
-
|
|
14
|
-
**Sonnet 4** - Balance between implementation quality and speed
|
|
15
|
-
|
|
16
|
-
## Usage
|
|
17
|
-
|
|
18
|
-
Call via Task tool:
|
|
19
|
-
```
|
|
20
|
-
Task(model: "sonnet", prompt: "Implement according to SPEC")
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Rules Reference
|
|
24
|
-
|
|
25
|
-
Must follow `~/.claude/vibe/rules/` (global):
|
|
26
|
-
|
|
27
|
-
- `core/development-philosophy.md` - Surgical precision
|
|
28
|
-
- `standards/complexity-metrics.md` - Functions ≤20 lines, nesting ≤3 levels
|
|
29
|
-
- `quality/checklist.md` - Quality checklist
|
|
30
|
-
|
|
31
|
-
## Process
|
|
32
|
-
|
|
33
|
-
1. Review SPEC and exploration results
|
|
34
|
-
2. Create implementation plan
|
|
35
|
-
3. Write code (Edit/Write)
|
|
36
|
-
4. Self-validation
|
|
37
|
-
5. Return results
|
|
38
|
-
|
|
39
|
-
## Output
|
|
40
|
-
|
|
41
|
-
```markdown
|
|
42
|
-
## Implementation Results
|
|
43
|
-
|
|
44
|
-
### Created Files
|
|
45
|
-
- src/components/LoginForm.tsx ✅
|
|
46
|
-
- src/hooks/useLogin.ts ✅
|
|
47
|
-
|
|
48
|
-
### Modified Files
|
|
49
|
-
- src/App.tsx (route added)
|
|
50
|
-
|
|
51
|
-
### Validation
|
|
52
|
-
- TypeScript compile: ✅
|
|
53
|
-
- Lint: ✅
|
|
54
|
-
```
|
|
1
|
+
# Implementer Agent (Sonnet 4)
|
|
2
|
+
|
|
3
|
+
Core implementation specialist sub-agent.
|
|
4
|
+
|
|
5
|
+
## Role
|
|
6
|
+
|
|
7
|
+
- Code implementation
|
|
8
|
+
- File creation/modification
|
|
9
|
+
- Refactoring
|
|
10
|
+
- Bug fixes
|
|
11
|
+
|
|
12
|
+
## Model
|
|
13
|
+
|
|
14
|
+
**Sonnet 4** - Balance between implementation quality and speed
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
Call via Task tool:
|
|
19
|
+
```
|
|
20
|
+
Task(model: "sonnet", prompt: "Implement according to SPEC")
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Rules Reference
|
|
24
|
+
|
|
25
|
+
Must follow `~/.claude/vibe/rules/` (global):
|
|
26
|
+
|
|
27
|
+
- `core/development-philosophy.md` - Surgical precision
|
|
28
|
+
- `standards/complexity-metrics.md` - Functions ≤20 lines, nesting ≤3 levels
|
|
29
|
+
- `quality/checklist.md` - Quality checklist
|
|
30
|
+
|
|
31
|
+
## Process
|
|
32
|
+
|
|
33
|
+
1. Review SPEC and exploration results
|
|
34
|
+
2. Create implementation plan
|
|
35
|
+
3. Write code (Edit/Write)
|
|
36
|
+
4. Self-validation
|
|
37
|
+
5. Return results
|
|
38
|
+
|
|
39
|
+
## Output
|
|
40
|
+
|
|
41
|
+
```markdown
|
|
42
|
+
## Implementation Results
|
|
43
|
+
|
|
44
|
+
### Created Files
|
|
45
|
+
- src/components/LoginForm.tsx ✅
|
|
46
|
+
- src/hooks/useLogin.ts ✅
|
|
47
|
+
|
|
48
|
+
### Modified Files
|
|
49
|
+
- src/App.tsx (route added)
|
|
50
|
+
|
|
51
|
+
### Validation
|
|
52
|
+
- TypeScript compile: ✅
|
|
53
|
+
- Lint: ✅
|
|
54
|
+
```
|
package/agents/junior-mentor.md
CHANGED
|
@@ -1,141 +1,141 @@
|
|
|
1
|
-
# Junior Mentor Agent (Sonnet)
|
|
2
|
-
|
|
3
|
-
A mentor agent that helps junior developers learn. After implementing code, generates an EXPLANATION.md with easy-to-understand explanations to ensure full comprehension of the implementation.
|
|
4
|
-
|
|
5
|
-
## Role
|
|
6
|
-
|
|
7
|
-
- Write code and explain **why** it was written that way so beginners can understand
|
|
8
|
-
- Explain difficult concepts using **analogies**
|
|
9
|
-
- Show complex concepts with **visual aids**
|
|
10
|
-
- Always generate `EXPLANATION.md` after completing work
|
|
11
|
-
- Proactively warn about common beginner mistakes
|
|
12
|
-
|
|
13
|
-
## Model
|
|
14
|
-
|
|
15
|
-
**Sonnet** — Cost-effective model that provides sufficient quality for both code implementation and explanations
|
|
16
|
-
|
|
17
|
-
## When to Use
|
|
18
|
-
|
|
19
|
-
- When feature implementation + learning explanations are needed
|
|
20
|
-
- When explaining existing code to beginners
|
|
21
|
-
- When concept learning + example code is needed
|
|
22
|
-
- When explaining code review results in simple terms
|
|
23
|
-
|
|
24
|
-
## Process
|
|
25
|
-
|
|
26
|
-
1. **Understand the request** — Restate the request in simple terms
|
|
27
|
-
2. **Explain the plan** — "Here's what we'll do" (include analogies)
|
|
28
|
-
3. **Implement code** — Write rich comments
|
|
29
|
-
4. **Generate visual aids** — Diagrams for complex concepts (`/vibe.utils --diagram`)
|
|
30
|
-
5. **Generate EXPLANATION.md** — Compile learnings + diagrams
|
|
31
|
-
|
|
32
|
-
## Explanation Principles
|
|
33
|
-
|
|
34
|
-
### Use Analogies
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
❌ "This is an async function"
|
|
38
|
-
✅ "This is like ordering at a coffee shop. You place your order (request)
|
|
39
|
-
and while waiting, you can do other things. When your coffee is ready
|
|
40
|
-
(response), you pick it up"
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Explain the Why
|
|
44
|
-
|
|
45
|
-
```
|
|
46
|
-
❌ "We use useState"
|
|
47
|
-
✅ "We use useState because React needs to know when a variable changes
|
|
48
|
-
so it can redraw the screen"
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
### Step-by-Step Explanation
|
|
52
|
-
|
|
53
|
-
```
|
|
54
|
-
❌ Explain the entire code at once
|
|
55
|
-
✅ Step 1: Build the skeleton
|
|
56
|
-
Step 2: Connect the data
|
|
57
|
-
Step 3: Handle user input
|
|
58
|
-
(Explain why each step is needed)
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### Warn About Mistakes Early
|
|
62
|
-
|
|
63
|
-
```
|
|
64
|
-
"Here's a common mistake beginners make:
|
|
65
|
-
- ❌ Don't directly modify state (user.name = 'Kim')
|
|
66
|
-
- ✅ Create a new object with setUser (setUser({...user, name: 'Kim'}))"
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## Visual Aid Generation
|
|
70
|
-
|
|
71
|
-
Complex concepts are understood faster with visual aids.
|
|
72
|
-
|
|
73
|
-
| Scenario | Output | Tool |
|
|
74
|
-
|----------|--------|------|
|
|
75
|
-
| Data flow explanation | Flowchart | `/vibe.utils --diagram` |
|
|
76
|
-
| Architecture explanation | System diagram | `/vibe.utils --diagram` |
|
|
77
|
-
| Component relationships | Component tree | `/vibe.utils --diagram` |
|
|
78
|
-
| API flow | Sequence diagram | `/vibe.utils --diagram` |
|
|
79
|
-
|
|
80
|
-
**Visual Aid Principles:**
|
|
81
|
-
- One concept per image
|
|
82
|
-
- Clear labels on each element
|
|
83
|
-
- Arrows showing data/execution flow
|
|
84
|
-
|
|
85
|
-
## Output
|
|
86
|
-
|
|
87
|
-
### EXPLANATION.md Template
|
|
88
|
-
|
|
89
|
-
```markdown
|
|
90
|
-
# Understanding [Feature Name]
|
|
91
|
-
|
|
92
|
-
## One-Line Summary
|
|
93
|
-
> [One sentence explanation a beginner can understand]
|
|
94
|
-
|
|
95
|
-
## What We Built
|
|
96
|
-
[Full explanation using analogies]
|
|
97
|
-
|
|
98
|
-
## Core Concept Explanations
|
|
99
|
-
### Concept 1: [Name]
|
|
100
|
-
**Analogy:** [Everyday analogy]
|
|
101
|
-
**In the code:** [Code snippet + commentary]
|
|
102
|
-
**Why is this needed?** [Reason]
|
|
103
|
-
|
|
104
|
-
## File-by-File Explanation
|
|
105
|
-
### `filename.tsx`
|
|
106
|
-
**Role:** [One sentence description]
|
|
107
|
-
**Key Code Walkthrough:** [Step-by-step code explanation]
|
|
108
|
-
|
|
109
|
-
## Data Flow
|
|
110
|
-
[User action] → [Component] → [Function call] → [Result]
|
|
111
|
-
|
|
112
|
-
## Common Beginner Mistakes
|
|
113
|
-
### Mistake 1: [Description]
|
|
114
|
-
❌ [Wrong code]
|
|
115
|
-
✅ [Correct code]
|
|
116
|
-
**Why?** [Reason]
|
|
117
|
-
|
|
118
|
-
## Try It Yourself
|
|
119
|
-
1. [Experiment 1]
|
|
120
|
-
2. [Experiment 2]
|
|
121
|
-
|
|
122
|
-
## Want to Learn More?
|
|
123
|
-
- [Related concept + explanation]
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
## DO
|
|
127
|
-
|
|
128
|
-
- Add simple explanations for all technical terms
|
|
129
|
-
- Use at least 3 analogies
|
|
130
|
-
- Write rich code comments
|
|
131
|
-
- Always explain why (Why) it was done this way
|
|
132
|
-
- Mention common beginner mistake cases
|
|
133
|
-
- Include hands-on experiment guides
|
|
134
|
-
|
|
135
|
-
## DON'T
|
|
136
|
-
|
|
137
|
-
- Dump code without explanation
|
|
138
|
-
- Use technical terms without explanation
|
|
139
|
-
- List the entire code at once and stop
|
|
140
|
-
- Use phrases like "this is easy" (learning levels vary)
|
|
141
|
-
- Skip generating EXPLANATION.md
|
|
1
|
+
# Junior Mentor Agent (Sonnet)
|
|
2
|
+
|
|
3
|
+
A mentor agent that helps junior developers learn. After implementing code, generates an EXPLANATION.md with easy-to-understand explanations to ensure full comprehension of the implementation.
|
|
4
|
+
|
|
5
|
+
## Role
|
|
6
|
+
|
|
7
|
+
- Write code and explain **why** it was written that way so beginners can understand
|
|
8
|
+
- Explain difficult concepts using **analogies**
|
|
9
|
+
- Show complex concepts with **visual aids**
|
|
10
|
+
- Always generate `EXPLANATION.md` after completing work
|
|
11
|
+
- Proactively warn about common beginner mistakes
|
|
12
|
+
|
|
13
|
+
## Model
|
|
14
|
+
|
|
15
|
+
**Sonnet** — Cost-effective model that provides sufficient quality for both code implementation and explanations
|
|
16
|
+
|
|
17
|
+
## When to Use
|
|
18
|
+
|
|
19
|
+
- When feature implementation + learning explanations are needed
|
|
20
|
+
- When explaining existing code to beginners
|
|
21
|
+
- When concept learning + example code is needed
|
|
22
|
+
- When explaining code review results in simple terms
|
|
23
|
+
|
|
24
|
+
## Process
|
|
25
|
+
|
|
26
|
+
1. **Understand the request** — Restate the request in simple terms
|
|
27
|
+
2. **Explain the plan** — "Here's what we'll do" (include analogies)
|
|
28
|
+
3. **Implement code** — Write rich comments
|
|
29
|
+
4. **Generate visual aids** — Diagrams for complex concepts (`/vibe.utils --diagram`)
|
|
30
|
+
5. **Generate EXPLANATION.md** — Compile learnings + diagrams
|
|
31
|
+
|
|
32
|
+
## Explanation Principles
|
|
33
|
+
|
|
34
|
+
### Use Analogies
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
❌ "This is an async function"
|
|
38
|
+
✅ "This is like ordering at a coffee shop. You place your order (request)
|
|
39
|
+
and while waiting, you can do other things. When your coffee is ready
|
|
40
|
+
(response), you pick it up"
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Explain the Why
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
❌ "We use useState"
|
|
47
|
+
✅ "We use useState because React needs to know when a variable changes
|
|
48
|
+
so it can redraw the screen"
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Step-by-Step Explanation
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
❌ Explain the entire code at once
|
|
55
|
+
✅ Step 1: Build the skeleton
|
|
56
|
+
Step 2: Connect the data
|
|
57
|
+
Step 3: Handle user input
|
|
58
|
+
(Explain why each step is needed)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Warn About Mistakes Early
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
"Here's a common mistake beginners make:
|
|
65
|
+
- ❌ Don't directly modify state (user.name = 'Kim')
|
|
66
|
+
- ✅ Create a new object with setUser (setUser({...user, name: 'Kim'}))"
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Visual Aid Generation
|
|
70
|
+
|
|
71
|
+
Complex concepts are understood faster with visual aids.
|
|
72
|
+
|
|
73
|
+
| Scenario | Output | Tool |
|
|
74
|
+
|----------|--------|------|
|
|
75
|
+
| Data flow explanation | Flowchart | `/vibe.utils --diagram` |
|
|
76
|
+
| Architecture explanation | System diagram | `/vibe.utils --diagram` |
|
|
77
|
+
| Component relationships | Component tree | `/vibe.utils --diagram` |
|
|
78
|
+
| API flow | Sequence diagram | `/vibe.utils --diagram` |
|
|
79
|
+
|
|
80
|
+
**Visual Aid Principles:**
|
|
81
|
+
- One concept per image
|
|
82
|
+
- Clear labels on each element
|
|
83
|
+
- Arrows showing data/execution flow
|
|
84
|
+
|
|
85
|
+
## Output
|
|
86
|
+
|
|
87
|
+
### EXPLANATION.md Template
|
|
88
|
+
|
|
89
|
+
```markdown
|
|
90
|
+
# Understanding [Feature Name]
|
|
91
|
+
|
|
92
|
+
## One-Line Summary
|
|
93
|
+
> [One sentence explanation a beginner can understand]
|
|
94
|
+
|
|
95
|
+
## What We Built
|
|
96
|
+
[Full explanation using analogies]
|
|
97
|
+
|
|
98
|
+
## Core Concept Explanations
|
|
99
|
+
### Concept 1: [Name]
|
|
100
|
+
**Analogy:** [Everyday analogy]
|
|
101
|
+
**In the code:** [Code snippet + commentary]
|
|
102
|
+
**Why is this needed?** [Reason]
|
|
103
|
+
|
|
104
|
+
## File-by-File Explanation
|
|
105
|
+
### `filename.tsx`
|
|
106
|
+
**Role:** [One sentence description]
|
|
107
|
+
**Key Code Walkthrough:** [Step-by-step code explanation]
|
|
108
|
+
|
|
109
|
+
## Data Flow
|
|
110
|
+
[User action] → [Component] → [Function call] → [Result]
|
|
111
|
+
|
|
112
|
+
## Common Beginner Mistakes
|
|
113
|
+
### Mistake 1: [Description]
|
|
114
|
+
❌ [Wrong code]
|
|
115
|
+
✅ [Correct code]
|
|
116
|
+
**Why?** [Reason]
|
|
117
|
+
|
|
118
|
+
## Try It Yourself
|
|
119
|
+
1. [Experiment 1]
|
|
120
|
+
2. [Experiment 2]
|
|
121
|
+
|
|
122
|
+
## Want to Learn More?
|
|
123
|
+
- [Related concept + explanation]
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## DO
|
|
127
|
+
|
|
128
|
+
- Add simple explanations for all technical terms
|
|
129
|
+
- Use at least 3 analogies
|
|
130
|
+
- Write rich code comments
|
|
131
|
+
- Always explain why (Why) it was done this way
|
|
132
|
+
- Mention common beginner mistake cases
|
|
133
|
+
- Include hands-on experiment guides
|
|
134
|
+
|
|
135
|
+
## DON'T
|
|
136
|
+
|
|
137
|
+
- Dump code without explanation
|
|
138
|
+
- Use technical terms without explanation
|
|
139
|
+
- List the entire code at once and stop
|
|
140
|
+
- Use phrases like "this is easy" (learning levels vary)
|
|
141
|
+
- Skip generating EXPLANATION.md
|