@jhm1909/ag-kit 0.1.0
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/.agent/ARCHITECTURE.md +189 -0
- package/.agent/known-registries.json +181 -0
- package/.agent/mcp_config.json +19 -0
- package/.agent/rules/clean-code.md +107 -0
- package/.agent/rules/documents.md +177 -0
- package/.agent/rules/git-workflow.md +68 -0
- package/.agent/rules/nano-banana.md +46 -0
- package/.agent/rules/research.md +35 -0
- package/.agent/rules/skill-loading.md +100 -0
- package/.agent/rules/skill-suggestion.md +47 -0
- package/.agent/rules/testing.md +52 -0
- package/.agent/rules/workflow-advisor.md +108 -0
- package/.agent/rules/workflow-skill-convention.md +127 -0
- package/.agent/skills/ai-engineer/SKILL.md +824 -0
- package/.agent/skills/ai-engineer/references/agentic-patterns.md +329 -0
- package/.agent/skills/ai-engineer/references/evaluation.md +493 -0
- package/.agent/skills/ai-engineer/references/llm.md +490 -0
- package/.agent/skills/ai-engineer/references/rag-advanced.md +444 -0
- package/.agent/skills/ai-engineer/references/serving-optimization.md +531 -0
- package/.agent/skills/ai-engineer/vector-db/README.md +137 -0
- package/.agent/skills/app-builder/SKILL.md +75 -0
- package/.agent/skills/app-builder/agent-coordination.md +71 -0
- package/.agent/skills/app-builder/feature-building.md +53 -0
- package/.agent/skills/app-builder/project-detection.md +34 -0
- package/.agent/skills/app-builder/scaffolding.md +118 -0
- package/.agent/skills/app-builder/tech-stack.md +41 -0
- package/.agent/skills/app-builder/templates/SKILL.md +39 -0
- package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/.agent/skills/backend-developer/SKILL.md +763 -0
- package/.agent/skills/backend-developer/references/general-patterns.md +65 -0
- package/.agent/skills/backend-developer/references/go-echo.md +68 -0
- package/.agent/skills/backend-developer/references/go-gin.md +76 -0
- package/.agent/skills/backend-developer/references/java-springboot.md +83 -0
- package/.agent/skills/backend-developer/references/node-express.md +64 -0
- package/.agent/skills/backend-developer/references/node-nestjs.md +69 -0
- package/.agent/skills/backend-developer/references/python-django.md +67 -0
- package/.agent/skills/backend-developer/references/python-fastapi.md +80 -0
- package/.agent/skills/blockchain-engineer/SKILL.md +975 -0
- package/.agent/skills/blockchain-engineer/references/deployment.md +28 -0
- package/.agent/skills/blockchain-engineer/references/evm.md +14 -0
- package/.agent/skills/blockchain-engineer/references/mechanisms.md +32 -0
- package/.agent/skills/blockchain-engineer/references/solidity.md +32 -0
- package/.agent/skills/business-analysis/SKILL.md +85 -0
- package/.agent/skills/business-analysis/references/best-practices/diagrams.md +141 -0
- package/.agent/skills/business-analysis/references/domains/ai-agent.md +94 -0
- package/.agent/skills/business-analysis/references/domains/blockchain-dapp.md +86 -0
- package/.agent/skills/business-analysis/references/domains/ecommerce.md +77 -0
- package/.agent/skills/business-analysis/references/domains/education.md +42 -0
- package/.agent/skills/business-analysis/references/domains/fintech.md +44 -0
- package/.agent/skills/business-analysis/references/domains/fnb.md +82 -0
- package/.agent/skills/business-analysis/references/domains/healthtech.md +44 -0
- package/.agent/skills/business-analysis/references/domains/internal-tools.md +38 -0
- package/.agent/skills/business-analysis/references/domains/marketplace.md +52 -0
- package/.agent/skills/business-analysis/references/domains/saas.md +36 -0
- package/.agent/skills/business-analysis/references/workflows/collaboration.md +41 -0
- package/.agent/skills/business-analysis/scripts/verify_mermaid.py +86 -0
- package/.agent/skills/business-analysis/templates/brd.md +46 -0
- package/.agent/skills/business-analysis/templates/change-request.md +41 -0
- package/.agent/skills/business-analysis/templates/prd-functional.md +38 -0
- package/.agent/skills/business-analysis/templates/use-case.md +40 -0
- package/.agent/skills/business-analysis/templates/user-story-detailed.md +36 -0
- package/.agent/skills/code-review/SKILL.md +113 -0
- package/.agent/skills/code-review/references/code-review-reception.md +209 -0
- package/.agent/skills/code-review/references/differential_review.md +59 -0
- package/.agent/skills/code-review/references/requesting-code-review.md +105 -0
- package/.agent/skills/code-review/references/spec_compliance.md +43 -0
- package/.agent/skills/code-review/references/verification-before-completion.md +139 -0
- package/.agent/skills/context-engineering/SKILL.md +68 -0
- package/.agent/skills/context-engineering/references/context-compression.md +84 -0
- package/.agent/skills/context-engineering/references/context-degradation.md +93 -0
- package/.agent/skills/context-engineering/references/context-fundamentals.md +75 -0
- package/.agent/skills/context-engineering/references/context-optimization.md +82 -0
- package/.agent/skills/context-engineering/references/evaluation.md +89 -0
- package/.agent/skills/context-engineering/references/memory-systems.md +88 -0
- package/.agent/skills/context-engineering/references/multi-agent-patterns.md +90 -0
- package/.agent/skills/context-engineering/references/project-development.md +97 -0
- package/.agent/skills/context-engineering/references/tool-design.md +86 -0
- package/.agent/skills/debugging/SKILL.md +60 -0
- package/.agent/skills/debugging/references/defense-in-depth.md +130 -0
- package/.agent/skills/debugging/references/root-cause-tracing.md +177 -0
- package/.agent/skills/debugging/references/systematic-debugging.md +295 -0
- package/.agent/skills/debugging/references/verification-before-completion.md +142 -0
- package/.agent/skills/designer/SKILL.md +159 -0
- package/.agent/skills/designer/concepts/apple-glass.md +48 -0
- package/.agent/skills/designer/concepts/aurora-gradients.md +26 -0
- package/.agent/skills/designer/concepts/bento-grids.md +14 -0
- package/.agent/skills/designer/concepts/claymorphism.md +27 -0
- package/.agent/skills/designer/concepts/neo-brutalism.md +32 -0
- package/.agent/skills/designer/data/app-interface.csv +31 -0
- package/.agent/skills/designer/data/charts.csv +26 -0
- package/.agent/skills/designer/data/colors.csv +162 -0
- package/.agent/skills/designer/data/design.csv +1776 -0
- package/.agent/skills/designer/data/icons.csv +106 -0
- package/.agent/skills/designer/data/landing.csv +35 -0
- package/.agent/skills/designer/data/products.csv +162 -0
- package/.agent/skills/designer/data/react-performance.csv +45 -0
- package/.agent/skills/designer/data/styles.csv +85 -0
- package/.agent/skills/designer/data/typography.csv +74 -0
- package/.agent/skills/designer/data/ui-reasoning.csv +162 -0
- package/.agent/skills/designer/data/ux-guidelines.csv +100 -0
- package/.agent/skills/designer/references/accessibility.md +172 -0
- package/.agent/skills/designer/references/branding.md +88 -0
- package/.agent/skills/designer/references/color-theory.md +139 -0
- package/.agent/skills/designer/references/creation.md +118 -0
- package/.agent/skills/designer/references/design-systems.md +219 -0
- package/.agent/skills/designer/references/frontend_design_aesthetics.md +57 -0
- package/.agent/skills/designer/references/layout.md +200 -0
- package/.agent/skills/designer/references/motion.md +92 -0
- package/.agent/skills/designer/references/review.md +100 -0
- package/.agent/skills/designer/references/trends.md +209 -0
- package/.agent/skills/designer/references/typography.md +190 -0
- package/.agent/skills/designer/scripts/remove_background.py +135 -0
- package/.agent/skills/designer/scripts/ui-search/__pycache__/core.cpython-314.pyc +0 -0
- package/.agent/skills/designer/scripts/ui-search/__pycache__/design_system.cpython-314.pyc +0 -0
- package/.agent/skills/designer/scripts/ui-search/core.py +217 -0
- package/.agent/skills/designer/scripts/ui-search/design_system.py +1067 -0
- package/.agent/skills/designer/scripts/ui-search/search.py +114 -0
- package/.agent/skills/designer/templates/design-motion-spec.md +30 -0
- package/.agent/skills/devops-engineer/SKILL.md +90 -0
- package/.agent/skills/devops-engineer/docker-compose/README.md +47 -0
- package/.agent/skills/devops-engineer/references/ci-cd-pipelines.md +76 -0
- package/.agent/skills/devops-engineer/references/cloud-providers.md +57 -0
- package/.agent/skills/devops-engineer/references/codebase-normalization.md +104 -0
- package/.agent/skills/devops-engineer/references/container-orchestration.md +69 -0
- package/.agent/skills/devops-engineer/references/iac-tools.md +63 -0
- package/.agent/skills/devops-engineer/references/observability-security.md +45 -0
- package/.agent/skills/devops-engineer/references/vercel-supabase.md +17 -0
- package/.agent/skills/devops-engineer/templates/release-notes.md +8 -0
- package/.agent/skills/frontend-developer/SKILL.md +125 -0
- package/.agent/skills/frontend-developer/react-nextjs/README.md +90 -0
- package/.agent/skills/frontend-developer/references/angular.md +52 -0
- package/.agent/skills/frontend-developer/references/composition_patterns.md +60 -0
- package/.agent/skills/frontend-developer/references/core-performance.md +68 -0
- package/.agent/skills/frontend-developer/references/modern-signals.md +43 -0
- package/.agent/skills/frontend-developer/references/react_performance_rules.md +55 -0
- package/.agent/skills/frontend-developer/references/vue-nuxt.md +55 -0
- package/.agent/skills/frontend-developer/scripts/validate_compliance.py +65 -0
- package/.agent/skills/frontend-developer/threejs/README.md +89 -0
- package/.agent/skills/frontend-developer/threejs/animation.md +552 -0
- package/.agent/skills/frontend-developer/threejs/fundamentals.md +488 -0
- package/.agent/skills/frontend-developer/threejs/geometry.md +548 -0
- package/.agent/skills/frontend-developer/threejs/interaction.md +660 -0
- package/.agent/skills/frontend-developer/threejs/lighting.md +481 -0
- package/.agent/skills/frontend-developer/threejs/loaders.md +623 -0
- package/.agent/skills/frontend-developer/threejs/materials.md +520 -0
- package/.agent/skills/frontend-developer/threejs/postprocessing.md +602 -0
- package/.agent/skills/frontend-developer/threejs/router.json +181 -0
- package/.agent/skills/frontend-developer/threejs/shaders.md +642 -0
- package/.agent/skills/frontend-developer/threejs/textures.md +628 -0
- package/.agent/skills/game-development/2d-games/SKILL.md +119 -0
- package/.agent/skills/game-development/3d-games/SKILL.md +135 -0
- package/.agent/skills/game-development/SKILL.md +167 -0
- package/.agent/skills/game-development/game-art/SKILL.md +185 -0
- package/.agent/skills/game-development/game-audio/SKILL.md +190 -0
- package/.agent/skills/game-development/game-design/SKILL.md +129 -0
- package/.agent/skills/game-development/mobile-games/SKILL.md +108 -0
- package/.agent/skills/game-development/multiplayer/SKILL.md +132 -0
- package/.agent/skills/game-development/pc-games/SKILL.md +144 -0
- package/.agent/skills/game-development/vr-ar/SKILL.md +123 -0
- package/.agent/skills/game-development/web-games/SKILL.md +150 -0
- package/.agent/skills/lead-architect/SKILL.md +85 -0
- package/.agent/skills/lead-architect/references/application-architecture.md +70 -0
- package/.agent/skills/lead-architect/references/infrastructure.md +51 -0
- package/.agent/skills/lead-architect/references/process.md +42 -0
- package/.agent/skills/lead-architect/references/system-architecture.md +62 -0
- package/.agent/skills/lead-architect/references/web-fullstack.md +82 -0
- package/.agent/skills/lead-architect/templates/adr.md +62 -0
- package/.agent/skills/lead-architect/templates/rfc.md +46 -0
- package/.agent/skills/lead-architect/templates/sdd.md +62 -0
- package/.agent/skills/lead-architect/templates/technical-spec.md +61 -0
- package/.agent/skills/marketer/SKILL.md +66 -0
- package/.agent/skills/marketer/remotion-best-practices/SKILL.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/3d.md +86 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/animations.md +29 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets/charts-bar-chart.tsx +173 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets/text-animations-typewriter.tsx +100 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets/text-animations-word-highlight.tsx +108 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets.md +78 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/audio.md +172 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/calculate-metadata.md +104 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/can-decode.md +75 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/charts.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/compositions.md +146 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/display-captions.md +126 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/extract-frames.md +229 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/fonts.md +152 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/get-audio-duration.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/get-video-dimensions.md +68 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/get-video-duration.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/gifs.md +138 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/images.md +130 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/import-srt-captions.md +67 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/lottie.md +68 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/measuring-dom-nodes.md +35 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/measuring-text.md +143 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/sequencing.md +106 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/tailwind.md +11 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/text-animations.md +20 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/timing.md +179 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/transcribe-captions.md +19 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/transitions.md +122 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/trimming.md +53 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/videos.md +171 -0
- package/.agent/skills/mcp-builder/SKILL.md +76 -0
- package/.agent/skills/mcp-builder/references/evaluation.md +602 -0
- package/.agent/skills/mcp-builder/references/mcp_best_practices.md +249 -0
- package/.agent/skills/mcp-builder/references/node_mcp_server.md +970 -0
- package/.agent/skills/mcp-builder/references/python_mcp_server.md +719 -0
- package/.agent/skills/mobile-developer/SKILL.md +83 -0
- package/.agent/skills/mobile-developer/api-routes/SKILL.md +389 -0
- package/.agent/skills/mobile-developer/building-ui/SKILL.md +335 -0
- package/.agent/skills/mobile-developer/building-ui/references/animations.md +220 -0
- package/.agent/skills/mobile-developer/building-ui/references/controls.md +270 -0
- package/.agent/skills/mobile-developer/building-ui/references/form-sheet.md +227 -0
- package/.agent/skills/mobile-developer/building-ui/references/gradients.md +106 -0
- package/.agent/skills/mobile-developer/building-ui/references/icons.md +213 -0
- package/.agent/skills/mobile-developer/building-ui/references/media.md +198 -0
- package/.agent/skills/mobile-developer/building-ui/references/route-structure.md +229 -0
- package/.agent/skills/mobile-developer/building-ui/references/search.md +248 -0
- package/.agent/skills/mobile-developer/building-ui/references/storage.md +121 -0
- package/.agent/skills/mobile-developer/building-ui/references/tabs.md +368 -0
- package/.agent/skills/mobile-developer/building-ui/references/visual-effects.md +197 -0
- package/.agent/skills/mobile-developer/building-ui/references/webgpu-three.md +605 -0
- package/.agent/skills/mobile-developer/cicd-workflows/SKILL.md +107 -0
- package/.agent/skills/mobile-developer/cicd-workflows/scripts/fetch.js +109 -0
- package/.agent/skills/mobile-developer/cicd-workflows/scripts/package.json +11 -0
- package/.agent/skills/mobile-developer/cicd-workflows/scripts/validate.js +84 -0
- package/.agent/skills/mobile-developer/data-fetching/SKILL.md +508 -0
- package/.agent/skills/mobile-developer/deployment/SKILL.md +207 -0
- package/.agent/skills/mobile-developer/deployment/references/app-store-metadata.md +479 -0
- package/.agent/skills/mobile-developer/deployment/references/ios-app-store.md +355 -0
- package/.agent/skills/mobile-developer/deployment/references/play-store.md +246 -0
- package/.agent/skills/mobile-developer/deployment/references/testflight.md +58 -0
- package/.agent/skills/mobile-developer/deployment/references/workflows.md +200 -0
- package/.agent/skills/mobile-developer/dev-client/SKILL.md +181 -0
- package/.agent/skills/mobile-developer/tailwind-setup/SKILL.md +501 -0
- package/.agent/skills/mobile-developer/upgrading-expo/SKILL.md +116 -0
- package/.agent/skills/mobile-developer/upgrading-expo/references/new-architecture.md +79 -0
- package/.agent/skills/mobile-developer/upgrading-expo/references/react-19.md +79 -0
- package/.agent/skills/mobile-developer/upgrading-expo/references/react-compiler.md +59 -0
- package/.agent/skills/mobile-developer/use-dom/SKILL.md +434 -0
- package/.agent/skills/modern-python/SKILL.md +122 -0
- package/.agent/skills/project-manager/SKILL.md +110 -0
- package/.agent/skills/project-manager/references/ba-collaboration.md +62 -0
- package/.agent/skills/project-manager/references/discovery_process.md +52 -0
- package/.agent/skills/project-manager/references/jobs_to_be_done.md +51 -0
- package/.agent/skills/project-manager/references/prd_development.md +52 -0
- package/.agent/skills/project-manager/references/rules-guide.md +55 -0
- package/.agent/skills/project-manager/references/skill-creation.md +98 -0
- package/.agent/skills/project-manager/references/strategic-frameworks.md +62 -0
- package/.agent/skills/project-manager/references/task-decomposition.md +194 -0
- package/.agent/skills/project-manager/references/workflows-guide.md +44 -0
- package/.agent/skills/project-manager/router.json +160 -0
- package/.agent/skills/project-manager/scripts/compare_skill.py +177 -0
- package/.agent/skills/project-manager/scripts/encoding_utils.py +36 -0
- package/.agent/skills/project-manager/scripts/init_skill.py +190 -0
- package/.agent/skills/project-manager/scripts/quick_validate.py +123 -0
- package/.agent/skills/project-manager/templates/pm-strategy-one-pager.md +6 -0
- package/.agent/skills/project-manager/templates/prd-strategic.md +38 -0
- package/.agent/skills/project-manager/templates/skill-questionnaire.md +118 -0
- package/.agent/skills/project-manager/templates/user-story-simple.md +14 -0
- package/.agent/skills/prompt-engineer/SKILL.md +319 -0
- package/.agent/skills/prompt-engineer/skill-creator/README.md +47 -0
- package/.agent/skills/qa-tester/SKILL.md +142 -0
- package/.agent/skills/qa-tester/assets/README.md +8 -0
- package/.agent/skills/qa-tester/references/accessibility_testing.md +35 -0
- package/.agent/skills/qa-tester/references/agent_browser.md +38 -0
- package/.agent/skills/qa-tester/references/automation/api_testing.md +23 -0
- package/.agent/skills/qa-tester/references/automation/best_practices.md +14 -0
- package/.agent/skills/qa-tester/references/automation/jest_vitest.md +26 -0
- package/.agent/skills/qa-tester/references/automation/playwright.md +30 -0
- package/.agent/skills/qa-tester/references/e2e_testing.md +46 -0
- package/.agent/skills/qa-tester/references/integration_testing.md +39 -0
- package/.agent/skills/qa-tester/references/performance_testing.md +44 -0
- package/.agent/skills/qa-tester/references/property_based_testing.md +44 -0
- package/.agent/skills/qa-tester/references/security_audit.md +53 -0
- package/.agent/skills/qa-tester/references/security_testing.md +30 -0
- package/.agent/skills/qa-tester/references/sharp_edges.md +49 -0
- package/.agent/skills/qa-tester/references/static_analysis.md +52 -0
- package/.agent/skills/qa-tester/references/supply_chain_audit.md +54 -0
- package/.agent/skills/qa-tester/references/test_case_standards.md +96 -0
- package/.agent/skills/qa-tester/references/test_report_template.md +32 -0
- package/.agent/skills/qa-tester/references/unit_testing.md +50 -0
- package/.agent/skills/qa-tester/references/visual_testing.md +32 -0
- package/.agent/skills/qa-tester/templates/uat-plan.md +34 -0
- package/.agent/skills/research-first/SKILL.md +118 -0
- package/.agent/skills-manifest.json +264 -0
- package/.agent/workflows/absorb.md +176 -0
- package/.agent/workflows/bootstrap.md +91 -0
- package/.agent/workflows/brainstorm.md +168 -0
- package/.agent/workflows/break-tasks.md +77 -0
- package/.agent/workflows/commit.md +349 -0
- package/.agent/workflows/custom-behavior.md +64 -0
- package/.agent/workflows/debug.md +65 -0
- package/.agent/workflows/development.md +49 -0
- package/.agent/workflows/documentation.md +221 -0
- package/.agent/workflows/gen-tests.md +53 -0
- package/.agent/workflows/guide.md +196 -0
- package/.agent/workflows/implement-feature.md +182 -0
- package/.agent/workflows/install-skill.md +193 -0
- package/.agent/workflows/qa.md +54 -0
- package/.agent/workflows/ui-ux-design.md +108 -0
- package/LICENSE +21 -0
- package/README.md +258 -0
- package/cli/index.js +345 -0
- package/cli/migrate-skills.js +113 -0
- package/cli/verify.js +291 -0
- package/package.json +49 -0
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
# Antigravity Kit Architecture
|
|
2
|
+
|
|
3
|
+
> **ag-kit** — Modular AI Agent Capability Expansion Toolkit
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Antigravity Kit is a multi-layer system:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
USER → /guide (Layer 1: Discovery)
|
|
13
|
+
→ Workflow Chain (Layer 2: Orchestration)
|
|
14
|
+
→ Invoke [skill] (Layer 3: Expertise)
|
|
15
|
+
→ Manifest (Layer 4: Routing)
|
|
16
|
+
→ Rules (Layer 5: Guardrails)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**Philosophy**: Friendly for beginners (guided workflows), powerful for experts (direct skill invocation).
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Directory Structure
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
.agent/
|
|
27
|
+
├── ARCHITECTURE.md # This file
|
|
28
|
+
├── skills-manifest.json # Single source of truth (v3.0)
|
|
29
|
+
├── known-registries.json # External skill registries
|
|
30
|
+
├── mcp_config.json # MCP server template
|
|
31
|
+
├── skills/ # 20 Skills + sub-skills
|
|
32
|
+
│ ├── ai-engineer/
|
|
33
|
+
│ ├── app-builder/
|
|
34
|
+
│ ├── backend-developer/
|
|
35
|
+
│ ├── blockchain-engineer/
|
|
36
|
+
│ ├── business-analysis/
|
|
37
|
+
│ ├── code-review/ # v2 — Trail of Bits security methodology
|
|
38
|
+
│ ├── context-engineering/
|
|
39
|
+
│ ├── debugging/
|
|
40
|
+
│ ├── designer/
|
|
41
|
+
│ ├── devops-engineer/
|
|
42
|
+
│ ├── frontend-developer/ # v4 — Vercel React rules
|
|
43
|
+
│ │ ├── react-nextjs/
|
|
44
|
+
│ │ ├── threejs/
|
|
45
|
+
│ │ └── references/ # react_performance_rules, composition_patterns
|
|
46
|
+
│ ├── game-development/
|
|
47
|
+
│ ├── lead-architect/
|
|
48
|
+
│ ├── marketer/
|
|
49
|
+
│ │ └── remotion-best-practices/
|
|
50
|
+
│ ├── mobile-developer/
|
|
51
|
+
│ │ ├── api-routes/
|
|
52
|
+
│ │ ├── building-ui/
|
|
53
|
+
│ │ ├── data-fetching/
|
|
54
|
+
│ │ ├── deployment/
|
|
55
|
+
│ │ ├── dev-client/
|
|
56
|
+
│ │ ├── tailwind-setup/
|
|
57
|
+
│ │ ├── upgrading-expo/
|
|
58
|
+
│ │ └── use-dom/
|
|
59
|
+
│ ├── modern-python/ # Trail of Bits toolchain
|
|
60
|
+
│ ├── project-manager/ # v5 — Dean Peters frameworks
|
|
61
|
+
│ │ └── references/ # discovery_process, prd_development, jobs_to_be_done
|
|
62
|
+
│ ├── prompt-engineer/
|
|
63
|
+
│ ├── qa-tester/ # v3 — Trail of Bits security audit
|
|
64
|
+
│ │ └── references/ # security_audit, supply_chain, PBT, etc.
|
|
65
|
+
│ └── research-first/
|
|
66
|
+
├── workflows/ # 15 Workflows
|
|
67
|
+
│ ├── guide.md # 🧭 Discovery
|
|
68
|
+
│ ├── brainstorm.md # 💡 Planning
|
|
69
|
+
│ ├── documentation.md # 📚 Specs
|
|
70
|
+
│ ├── break-tasks.md # 📋 Task breakdown
|
|
71
|
+
│ ├── implement-feature.md # 🔨 Coding
|
|
72
|
+
│ ├── development.md # 🐛 Quick fixes
|
|
73
|
+
│ ├── debug.md # 🔬 Scientific debugging
|
|
74
|
+
│ ├── ui-ux-design.md # 🎨 Design
|
|
75
|
+
│ ├── qa.md # 🧪 Test plans
|
|
76
|
+
│ ├── gen-tests.md # ✅ Test code
|
|
77
|
+
│ ├── absorb.md # 🔍 Study reference kits
|
|
78
|
+
│ ├── commit.md # 📦 Git (3-mode)
|
|
79
|
+
│ ├── bootstrap.md # 🚀 Project scaffolding
|
|
80
|
+
│ ├── install-skill.md # 📥 On-demand skill installer
|
|
81
|
+
│ └── custom-behavior.md # ⚙️ Meta-config
|
|
82
|
+
├── rules/ # 10 Always-on Rules
|
|
83
|
+
│ ├── clean-code.md
|
|
84
|
+
│ ├── documents.md # Dewey Decimal doc structure
|
|
85
|
+
│ ├── git-workflow.md
|
|
86
|
+
│ ├── nano-banana.md # Image generation convention
|
|
87
|
+
│ ├── research.md
|
|
88
|
+
│ ├── skill-loading.md # Skill activation protocol
|
|
89
|
+
│ ├── skill-suggestion.md # Auto-suggest skills
|
|
90
|
+
│ ├── testing.md
|
|
91
|
+
│ ├── workflow-advisor.md # Auto-suggest workflow chains
|
|
92
|
+
│ └── workflow-skill-convention.md # Layer architecture
|
|
93
|
+
└── tmp/ # Temporary files (gitignored)
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Skills (20 primary + sub-skills)
|
|
99
|
+
|
|
100
|
+
| Skill | Domain | Version | Sources |
|
|
101
|
+
|-------|--------|---------|---------|
|
|
102
|
+
| `project-manager` | management | v5.0 | Dean Peters PM frameworks |
|
|
103
|
+
| `business-analysis` | analysis | — | — |
|
|
104
|
+
| `qa-tester` | qa | v3.0 | Trail of Bits security |
|
|
105
|
+
| `code-review` | qa | v2.0 | Trail of Bits differential review |
|
|
106
|
+
| `frontend-developer` | web | v4.0 | Vercel React rules |
|
|
107
|
+
| `backend-developer` | infra | — | — |
|
|
108
|
+
| `mobile-developer` | mobile | — | — |
|
|
109
|
+
| `designer` | design | — | — |
|
|
110
|
+
| `devops-engineer` | infra | — | — |
|
|
111
|
+
| `lead-architect` | infra | — | — |
|
|
112
|
+
| `ai-engineer` | ai | — | — |
|
|
113
|
+
| `blockchain-engineer` | blockchain | — | — |
|
|
114
|
+
| `marketer` | marketing | — | — |
|
|
115
|
+
| `prompt-engineer` | ai | — | — |
|
|
116
|
+
| `app-builder` | meta | — | — |
|
|
117
|
+
| `game-development` | game | — | — |
|
|
118
|
+
| `context-engineering` | meta | — | — |
|
|
119
|
+
| `debugging` | qa | — | — |
|
|
120
|
+
| `research-first` | meta | — | — |
|
|
121
|
+
| `modern-python` | tooling | v1.0 | Trail of Bits uv/ruff/ty |
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Workflows (15)
|
|
126
|
+
|
|
127
|
+
### Workflow Chains
|
|
128
|
+
|
|
129
|
+
```
|
|
130
|
+
New Project: /brainstorm → /documentation → /break-tasks → /implement-feature → /commit
|
|
131
|
+
New Feature: /break-tasks → /implement-feature → /gen-tests → /commit
|
|
132
|
+
Bug Fix: /development → /gen-tests → /commit
|
|
133
|
+
Debug: /debug → /commit
|
|
134
|
+
UI/UX: /ui-ux-design → /break-tasks → /implement-feature → /commit
|
|
135
|
+
Study Kit: /absorb → /break-tasks → /implement-feature → /commit
|
|
136
|
+
MVP Sprint: /brainstorm → /documentation → [/break-tasks → /implement-feature → /commit] × N
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Commit Modes
|
|
140
|
+
|
|
141
|
+
| Mode | Branch | Diff | .gitignore | Protected | Message | Push |
|
|
142
|
+
|------|--------|------|------------|-----------|---------|------|
|
|
143
|
+
| ⚡ Quick | skip | brief | skip | skip | auto | auto |
|
|
144
|
+
| 🛡️ Safe | check | full | auto-fix | confirm | approve | auto |
|
|
145
|
+
| 🎛️ Custom | ask | full | ask | list all | edit | ask |
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## Rules (10)
|
|
150
|
+
|
|
151
|
+
| Rule | Purpose |
|
|
152
|
+
|------|---------|
|
|
153
|
+
| `clean-code` | Coding standards |
|
|
154
|
+
| `documents` | Dewey Decimal doc structure |
|
|
155
|
+
| `git-workflow` | Branch strategy, commit format |
|
|
156
|
+
| `nano-banana` | Image generation convention |
|
|
157
|
+
| `research` | Deep research protocol |
|
|
158
|
+
| `skill-loading` | Skill activation routing |
|
|
159
|
+
| `skill-suggestion` | Auto-suggest relevant skills |
|
|
160
|
+
| `testing` | Test coverage requirements |
|
|
161
|
+
| `workflow-advisor` | Auto-suggest workflow chains |
|
|
162
|
+
| `workflow-skill-convention` | 5-layer architecture enforcement |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## Profiles
|
|
167
|
+
|
|
168
|
+
Pre-configured skill bundles (via `ag-kit init --profile`):
|
|
169
|
+
|
|
170
|
+
| Profile | Skills | Optional |
|
|
171
|
+
|---------|--------|----------|
|
|
172
|
+
| `web-frontend` | frontend, designer | react-nextjs, threejs |
|
|
173
|
+
| `fullstack-saas` | frontend, backend, devops, PM, QA | react-nextjs, ai-engineer |
|
|
174
|
+
| `mobile-app` | mobile, designer, QA | backend |
|
|
175
|
+
| `video-content` | marketer, frontend, remotion | threejs |
|
|
176
|
+
| `ai-powered-app` | ai-engineer, frontend, backend | lead-architect |
|
|
177
|
+
| `blockchain-dapp` | blockchain, frontend, backend | devops |
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Statistics
|
|
182
|
+
|
|
183
|
+
| Metric | Count |
|
|
184
|
+
|--------|------:|
|
|
185
|
+
| Skills | 20 primary + sub-skills |
|
|
186
|
+
| Workflows | 15 |
|
|
187
|
+
| Rules | 10 |
|
|
188
|
+
| Profiles | 6 |
|
|
189
|
+
| Absorbed Sources | Trail of Bits, Vercel, Dean Peters |
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "Curated registry of trusted skill sources for /install-skill workflow",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"updated": "2026-03-27",
|
|
5
|
+
"registries": [
|
|
6
|
+
{
|
|
7
|
+
"id": "anthropic-official",
|
|
8
|
+
"org": "anthropics",
|
|
9
|
+
"repo": "skills",
|
|
10
|
+
"url": "https://github.com/anthropics/skills",
|
|
11
|
+
"trust": "official",
|
|
12
|
+
"skills_path": "skills/",
|
|
13
|
+
"skills": [
|
|
14
|
+
{ "name": "frontend-design", "description": "Frontend design and UI/UX development" },
|
|
15
|
+
{ "name": "mcp-builder", "description": "Create MCP servers for external APIs" },
|
|
16
|
+
{ "name": "webapp-testing", "description": "Test web apps using Playwright" },
|
|
17
|
+
{ "name": "skill-creator", "description": "Guide for creating new skills" },
|
|
18
|
+
{ "name": "docx", "description": "Create, edit, analyze Word documents" },
|
|
19
|
+
{ "name": "pdf", "description": "Extract text, create PDFs, handle forms" },
|
|
20
|
+
{ "name": "xlsx", "description": "Create, edit, analyze Excel spreadsheets" }
|
|
21
|
+
]
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"id": "vercel-engineering",
|
|
25
|
+
"org": "vercel-labs",
|
|
26
|
+
"repo": "agent-skills",
|
|
27
|
+
"url": "https://github.com/vercel-labs/agent-skills",
|
|
28
|
+
"trust": "official",
|
|
29
|
+
"skills_path": "skills/",
|
|
30
|
+
"skills": [
|
|
31
|
+
{ "name": "react-best-practices", "description": "65+ React optimization rules from Vercel" },
|
|
32
|
+
{ "name": "web-design-guidelines", "description": "Web design standards and guidelines" },
|
|
33
|
+
{ "name": "composition-patterns", "description": "React component composition patterns" }
|
|
34
|
+
]
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"id": "vercel-next",
|
|
38
|
+
"org": "vercel-labs",
|
|
39
|
+
"repo": "next-skills",
|
|
40
|
+
"url": "https://github.com/vercel-labs/next-skills",
|
|
41
|
+
"trust": "official",
|
|
42
|
+
"skills_path": "skills/",
|
|
43
|
+
"skills": [
|
|
44
|
+
{ "name": "next-best-practices", "description": "Next.js best practices and patterns" },
|
|
45
|
+
{ "name": "next-cache-components", "description": "Caching strategies in Next.js" },
|
|
46
|
+
{ "name": "next-upgrade", "description": "Upgrade Next.js projects" }
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"id": "stripe",
|
|
51
|
+
"org": "stripe",
|
|
52
|
+
"repo": "ai",
|
|
53
|
+
"url": "https://github.com/stripe/ai",
|
|
54
|
+
"trust": "official",
|
|
55
|
+
"skills_path": "skills/",
|
|
56
|
+
"skills": [
|
|
57
|
+
{ "name": "stripe-best-practices", "description": "Best practices for Stripe integrations" },
|
|
58
|
+
{ "name": "upgrade-stripe", "description": "Upgrade Stripe SDK and API versions" }
|
|
59
|
+
]
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"id": "cloudflare",
|
|
63
|
+
"org": "cloudflare",
|
|
64
|
+
"repo": "skills",
|
|
65
|
+
"url": "https://github.com/cloudflare/skills",
|
|
66
|
+
"trust": "official",
|
|
67
|
+
"skills_path": "skills/",
|
|
68
|
+
"skills": [
|
|
69
|
+
{ "name": "agents-sdk", "description": "Build stateful AI agents on Cloudflare" },
|
|
70
|
+
{ "name": "building-mcp-server-on-cloudflare", "description": "Build remote MCP servers" },
|
|
71
|
+
{ "name": "durable-objects", "description": "Stateful coordination with RPC and SQLite" },
|
|
72
|
+
{ "name": "web-perf", "description": "Audit Core Web Vitals" },
|
|
73
|
+
{ "name": "wrangler", "description": "Deploy Workers, KV, R2, D1, Queues" }
|
|
74
|
+
]
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"id": "trailofbits-security",
|
|
78
|
+
"org": "trailofbits",
|
|
79
|
+
"repo": "skills",
|
|
80
|
+
"url": "https://github.com/trailofbits/skills",
|
|
81
|
+
"trust": "official",
|
|
82
|
+
"skills_path": "plugins/",
|
|
83
|
+
"skills": [
|
|
84
|
+
{ "name": "static-analysis", "description": "CodeQL, Semgrep, and SARIF toolkit" },
|
|
85
|
+
{ "name": "semgrep-rule-creator", "description": "Create Semgrep vulnerability rules" },
|
|
86
|
+
{ "name": "differential-review", "description": "Security-focused diff review" },
|
|
87
|
+
{ "name": "property-based-testing", "description": "Property testing for multiple languages" },
|
|
88
|
+
{ "name": "modern-python", "description": "Modern Python: uv, ruff, ty, pytest" },
|
|
89
|
+
{ "name": "insecure-defaults", "description": "Detect hardcoded secrets, weak crypto" }
|
|
90
|
+
]
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"id": "sentry",
|
|
94
|
+
"org": "getsentry",
|
|
95
|
+
"repo": "skills",
|
|
96
|
+
"url": "https://github.com/getsentry/skills",
|
|
97
|
+
"trust": "official",
|
|
98
|
+
"skills_path": "plugins/sentry-skills/skills/",
|
|
99
|
+
"skills": [
|
|
100
|
+
{ "name": "code-review", "description": "Sentry's code review workflow" },
|
|
101
|
+
{ "name": "find-bugs", "description": "Find and identify bugs in code" },
|
|
102
|
+
{ "name": "create-pr", "description": "Create pull requests" },
|
|
103
|
+
{ "name": "commit", "description": "Create commits with best practices" }
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"id": "openai",
|
|
108
|
+
"org": "openai",
|
|
109
|
+
"repo": "skills",
|
|
110
|
+
"url": "https://github.com/openai/skills",
|
|
111
|
+
"trust": "official",
|
|
112
|
+
"skills_path": "skills/.curated/",
|
|
113
|
+
"skills": [
|
|
114
|
+
{ "name": "security-best-practices", "description": "Language-specific security review" },
|
|
115
|
+
{ "name": "security-threat-model", "description": "Generate repo-specific threat models" },
|
|
116
|
+
{ "name": "playwright", "description": "Browser automation for testing" },
|
|
117
|
+
{ "name": "jupyter-notebook", "description": "Clean, reproducible Jupyter notebooks" }
|
|
118
|
+
]
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"id": "supabase",
|
|
122
|
+
"org": "supabase",
|
|
123
|
+
"repo": "agent-skills",
|
|
124
|
+
"url": "https://github.com/supabase/agent-skills",
|
|
125
|
+
"trust": "official",
|
|
126
|
+
"skills_path": "skills/",
|
|
127
|
+
"skills": [
|
|
128
|
+
{ "name": "supabase-postgres-best-practices", "description": "PostgreSQL best practices for Supabase" }
|
|
129
|
+
]
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"id": "google-gemini",
|
|
133
|
+
"org": "google-gemini",
|
|
134
|
+
"repo": "gemini-skills",
|
|
135
|
+
"url": "https://github.com/google-gemini/gemini-skills",
|
|
136
|
+
"trust": "official",
|
|
137
|
+
"skills_path": "skills/",
|
|
138
|
+
"skills": [
|
|
139
|
+
{ "name": "gemini-api-dev", "description": "Best practices for Gemini API apps" },
|
|
140
|
+
{ "name": "gemini-live-api-dev", "description": "Real-time streaming with Gemini Live API" }
|
|
141
|
+
]
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"id": "expo",
|
|
145
|
+
"org": "expo",
|
|
146
|
+
"repo": "skills",
|
|
147
|
+
"url": "https://github.com/expo/skills",
|
|
148
|
+
"trust": "official",
|
|
149
|
+
"skills_path": "plugins/expo/skills/",
|
|
150
|
+
"skills": [
|
|
151
|
+
{ "name": "building-native-ui", "description": "Expo Router, styling, animations" },
|
|
152
|
+
{ "name": "native-data-fetching", "description": "Network requests, caching, offline" }
|
|
153
|
+
]
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"id": "huggingface",
|
|
157
|
+
"org": "huggingface",
|
|
158
|
+
"repo": "skills",
|
|
159
|
+
"url": "https://github.com/huggingface/skills",
|
|
160
|
+
"trust": "official",
|
|
161
|
+
"skills_path": "skills/",
|
|
162
|
+
"skills": [
|
|
163
|
+
{ "name": "huggingface-gradio", "description": "Build Gradio apps on HF Spaces" },
|
|
164
|
+
{ "name": "transformers.js", "description": "Run ML models in the browser" },
|
|
165
|
+
{ "name": "hugging-face-model-trainer", "description": "Train models with TRL: SFT, DPO, GRPO" }
|
|
166
|
+
]
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"id": "figma",
|
|
170
|
+
"org": "figma",
|
|
171
|
+
"repo": "mcp-server-guide",
|
|
172
|
+
"url": "https://github.com/figma/mcp-server-guide",
|
|
173
|
+
"trust": "official",
|
|
174
|
+
"skills_path": "skills/",
|
|
175
|
+
"skills": [
|
|
176
|
+
{ "name": "figma-implement-design", "description": "Figma design to production code" },
|
|
177
|
+
{ "name": "figma-generate-design", "description": "Build screens in Figma from code" }
|
|
178
|
+
]
|
|
179
|
+
}
|
|
180
|
+
]
|
|
181
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"mcpServers": {
|
|
3
|
+
"context7": {
|
|
4
|
+
"command": "npx",
|
|
5
|
+
"args": ["-y", "@upstash/context7-mcp"]
|
|
6
|
+
},
|
|
7
|
+
"sequential-thinking": {
|
|
8
|
+
"command": "npx",
|
|
9
|
+
"args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]
|
|
10
|
+
},
|
|
11
|
+
"github": {
|
|
12
|
+
"command": "npx",
|
|
13
|
+
"args": ["-y", "@modelcontextprotocol/server-github"],
|
|
14
|
+
"env": {
|
|
15
|
+
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_TOKEN"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
---
|
|
2
|
+
trigger: glob
|
|
3
|
+
globs: **/*.{ts,tsx,js,jsx,py,go,java,rb,c,cpp,h,hpp,rs,css,html}
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Clean Code Standards
|
|
7
|
+
|
|
8
|
+
## Core Principles
|
|
9
|
+
|
|
10
|
+
- **SOLID**: Follow Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, and Dependency Inversion principles.
|
|
11
|
+
- **DRY (Don't Repeat Yourself)**: Extract common logic into functions or constants.
|
|
12
|
+
- **KISS (Keep It Simple, Stupid)**: Avoid over-engineering. Code should be easy to understand.
|
|
13
|
+
- **YAGNI (You Aren't Gonna Need It)**: Do not implement features or abstraction "just in case".
|
|
14
|
+
|
|
15
|
+
## Naming Conventions
|
|
16
|
+
|
|
17
|
+
- Variables and functions should be descriptive (e.g., `isUserLoggedIn` instead of `flag`).
|
|
18
|
+
- Use consistent casing appropriate for the language (e.g., camelCase for JS/TS functions, snake_case for Python).
|
|
19
|
+
- Boolean variables should start with `is`, `has`, `should`, or `can`.
|
|
20
|
+
|
|
21
|
+
## Functions
|
|
22
|
+
|
|
23
|
+
- Functions should ideally do one thing and do it well.
|
|
24
|
+
- Keep functions short. If a function is too long, break it down.
|
|
25
|
+
- Limit the number of arguments (3 or fewer is ideal).
|
|
26
|
+
|
|
27
|
+
## Comments
|
|
28
|
+
|
|
29
|
+
- Comments should explain "why" something is done, not "what" the code does (unless it's complex/unintuitive).
|
|
30
|
+
- Remove commented-out code.
|
|
31
|
+
|
|
32
|
+
## Error Handling
|
|
33
|
+
|
|
34
|
+
- Context-aware error handling. Do not silently swallow errors.
|
|
35
|
+
- Use explicit error types where possible.
|
|
36
|
+
|
|
37
|
+
## Testing
|
|
38
|
+
|
|
39
|
+
- Write testable code. Avoid global state and side effects where possible.
|
|
40
|
+
|
|
41
|
+
## File Length Limits
|
|
42
|
+
|
|
43
|
+
Files should be kept concise and focused. If a file exceeds these limits, consider splitting it:
|
|
44
|
+
|
|
45
|
+
| File Type | Max Lines | Notes |
|
|
46
|
+
| --------------------------- | --------- | ---------------------------------------------- |
|
|
47
|
+
| Components (`.tsx`, `.jsx`) | 200-300 | Split into smaller components or extract hooks |
|
|
48
|
+
| Utility/Helper files | 150-200 | Group related utilities, split by domain |
|
|
49
|
+
| API Routes/Handlers | 100-150 | Extract business logic to services |
|
|
50
|
+
| Test files | 300-400 | Group by feature, use describe blocks |
|
|
51
|
+
| Styles (`.css`) | 200-300 | Use CSS modules or split by component |
|
|
52
|
+
| Config files | 100 | Keep minimal, use separate config files |
|
|
53
|
+
|
|
54
|
+
**When to split:**
|
|
55
|
+
|
|
56
|
+
- When a file has multiple responsibilities (violates SRP)
|
|
57
|
+
- When scrolling becomes difficult to follow logic
|
|
58
|
+
- When imports section becomes excessively long (>15 imports)
|
|
59
|
+
- When the file has multiple large functions that could be independent
|
|
60
|
+
|
|
61
|
+
## File Header Comments
|
|
62
|
+
|
|
63
|
+
Every new file MUST include a header comment at the top describing its purpose:
|
|
64
|
+
|
|
65
|
+
**Format for TypeScript/JavaScript:**
|
|
66
|
+
|
|
67
|
+
```typescript
|
|
68
|
+
/**
|
|
69
|
+
* @file [filename]
|
|
70
|
+
* @description [Brief description of what this file contains and its purpose]
|
|
71
|
+
*
|
|
72
|
+
* @example (optional - for utilities/hooks)
|
|
73
|
+
* // Usage example here
|
|
74
|
+
*/
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**Format for CSS:**
|
|
78
|
+
|
|
79
|
+
```css
|
|
80
|
+
/**
|
|
81
|
+
* @file [filename]
|
|
82
|
+
* @description [Brief description of styles contained]
|
|
83
|
+
*
|
|
84
|
+
* Sections:
|
|
85
|
+
* - [List main sections if applicable]
|
|
86
|
+
*/
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Format for Python:**
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
"""
|
|
93
|
+
[filename]
|
|
94
|
+
|
|
95
|
+
[Brief description of what this module contains and its purpose]
|
|
96
|
+
|
|
97
|
+
Example (optional):
|
|
98
|
+
>>> usage_example()
|
|
99
|
+
"""
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
**Requirements:**
|
|
103
|
+
|
|
104
|
+
- `@file`: The filename (e.g., `user.service.ts`)
|
|
105
|
+
- `@description`: 1-3 sentences explaining the file's purpose
|
|
106
|
+
- Keep headers concise but informative
|
|
107
|
+
- Update headers when file purpose changes significantly
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
---
|
|
2
|
+
trigger: model_decision
|
|
3
|
+
description: Always apply when working with documentation files
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation Structure Rule
|
|
7
|
+
|
|
8
|
+
## Critical Rules (MUST Follow)
|
|
9
|
+
|
|
10
|
+
1. **MUST** save all documents to `docs/` folder - NEVER create documents in project root or other folders
|
|
11
|
+
2. **MUST** use Dewey Decimal folder structure (010, 020, 030, etc.)
|
|
12
|
+
3. **MUST** include YAML frontmatter in every document
|
|
13
|
+
4. **MUST** update relevant MOC file after creating a new document
|
|
14
|
+
5. **MUST** use wiki-links `[[Document-Name]]` for cross-references
|
|
15
|
+
6. **MUST NOT** create custom folder structures like `01-product/`, `02-analysis/`
|
|
16
|
+
7. **MUST NOT** create documents without checking Document Type Mapping first
|
|
17
|
+
|
|
18
|
+
## Decision Flow
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
22
|
+
│ BEFORE creating any document, ask yourself: │
|
|
23
|
+
├─────────────────────────────────────────────────────────────┤
|
|
24
|
+
│ 1. Does docs/ folder exist? │
|
|
25
|
+
│ NO → Create folder structure (see Required Structure) │
|
|
26
|
+
│ YES → Continue │
|
|
27
|
+
├─────────────────────────────────────────────────────────────┤
|
|
28
|
+
│ 2. What type of document is this? │
|
|
29
|
+
│ → Look up in Document Type Mapping table │
|
|
30
|
+
│ → Get exact target folder and naming convention │
|
|
31
|
+
├─────────────────────────────────────────────────────────────┤
|
|
32
|
+
│ 3. Does target folder exist? │
|
|
33
|
+
│ NO → Create it with proper Dewey Decimal prefix │
|
|
34
|
+
│ YES → Continue │
|
|
35
|
+
├─────────────────────────────────────────────────────────────┤
|
|
36
|
+
│ 4. Create document with: │
|
|
37
|
+
│ → Correct naming convention │
|
|
38
|
+
│ → Required frontmatter │
|
|
39
|
+
│ → Wiki-links to related documents │
|
|
40
|
+
├─────────────────────────────────────────────────────────────┤
|
|
41
|
+
│ 5. AFTER creating document: │
|
|
42
|
+
│ → Update parent folder's MOC file │
|
|
43
|
+
│ → Update 000-Index.md if major document │
|
|
44
|
+
└─────────────────────────────────────────────────────────────┘
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Document Type Mapping
|
|
48
|
+
|
|
49
|
+
| Category | Document Type | Target Folder | Naming Convention |
|
|
50
|
+
| -------------------- | ------------------- | -------------------------------------- | -------------------------- |
|
|
51
|
+
| **010-Planning** | Roadmap | `docs/010-Planning/` | `Roadmap.md` |
|
|
52
|
+
| | OKRs | `docs/010-Planning/` | `OKRs.md` |
|
|
53
|
+
| | Sprint | `docs/010-Planning/Sprints/` | `Sprint-{NNN}.md` |
|
|
54
|
+
| **020-Requirements** | PRD | `docs/020-Requirements/` | `PRD-{ProjectName}.md` |
|
|
55
|
+
| | BRD | `docs/020-Requirements/BRD/` | `BRD-{NNN}-{Title}.md` |
|
|
56
|
+
| | Use Case | `docs/020-Requirements/Use-Cases/` | `UC-{NN}-{Title}.md` |
|
|
57
|
+
| **022-User-Stories** | Epic | `docs/022-User-Stories/Epics/` | `Epic-{Title}.md` |
|
|
58
|
+
| | User Story | `docs/022-User-Stories/Backlog/` | `Story-{Title}.md` |
|
|
59
|
+
| | Active Story | `docs/022-User-Stories/Active-Sprint/` | `Story-{Title}.md` |
|
|
60
|
+
| **030-Specs** | ADR | `docs/030-Specs/Architecture/` | `ADR-{NNN}-{Title}.md` |
|
|
61
|
+
| | RFC | `docs/030-Specs/Architecture/` | `RFC-{NNN}-{Title}.md` |
|
|
62
|
+
| | SDD (System Design) | `docs/030-Specs/Architecture/` | `SDD-{ProjectName}.md` |
|
|
63
|
+
| | Technical Spec | `docs/030-Specs/` | `Spec-{Feature}.md` |
|
|
64
|
+
| | API Endpoint Spec | `docs/030-Specs/API/` | `Endpoint-{Name}.md` |
|
|
65
|
+
| | DB Schema | `docs/030-Specs/Schema/` | `DB-Entity-{Name}.md` |
|
|
66
|
+
| **035-QA** | Test Plan | `docs/035-QA/Test-Plans/` | `MTP-{Name}.md` |
|
|
67
|
+
| | Test Case | `docs/035-QA/Test-Cases/` | `TC-{Feature}-{NNN}.md` |
|
|
68
|
+
| **040-Design** | Design System | `docs/040-Design/Design-System/` | `{Component}.md` |
|
|
69
|
+
| | Wireframe | `docs/040-Design/Wireframes/` | `WF-{Screen}-{Device}.png` |
|
|
70
|
+
| **050-Research** | Research/Analysis | `docs/050-Research/{Topic}/` | `Analysis-{Topic}.md` |
|
|
71
|
+
| | Absorb Plan | `docs/050-Research/{SourceName}/` | `Absorb-{SourceName}.md` |
|
|
72
|
+
| | Research Index | `docs/050-Research/` | `Research-MOC.md` |
|
|
73
|
+
| **060-Manuals** | User Guide | `docs/060-Manuals/User-Guide/` | `{Topic}.md` |
|
|
74
|
+
| | Admin Guide | `docs/060-Manuals/Admin-Guide/` | `{Topic}.md` |
|
|
75
|
+
| **090-Archive** | Deprecated Docs | `docs/090-Archive/` | `{Original-Name}.md` |
|
|
76
|
+
| **999-Resources** | Meeting Notes | `docs/999-Resources/Meeting-Notes/` | `{Type}-{Date}.md` |
|
|
77
|
+
| | Glossary | `docs/999-Resources/` | `Glossary.md` |
|
|
78
|
+
| | Template | `docs/999-Resources/Templates/` | `Template-{Type}.md` |
|
|
79
|
+
|
|
80
|
+
## Required Folder Structure
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
docs/
|
|
84
|
+
├── 000-Index.md # "Home Page" - MUST exist
|
|
85
|
+
│
|
|
86
|
+
├── 010-Planning/ # Strategy, Timelines, Roadmaps
|
|
87
|
+
│ ├── Planning-MOC.md # REQUIRED MOC
|
|
88
|
+
│ ├── Roadmap.md
|
|
89
|
+
│ ├── OKRs.md
|
|
90
|
+
│ └── Sprints/
|
|
91
|
+
│
|
|
92
|
+
├── 020-Requirements/ # Business Requirements
|
|
93
|
+
│ ├── Requirements-MOC.md # REQUIRED MOC
|
|
94
|
+
│ ├── BRD/
|
|
95
|
+
│ └── Use-Cases/
|
|
96
|
+
│
|
|
97
|
+
├── 022-User-Stories/ # Agile Backlog
|
|
98
|
+
│ ├── Stories-MOC.md # REQUIRED MOC
|
|
99
|
+
│ ├── Epics/
|
|
100
|
+
│ ├── Active-Sprint/
|
|
101
|
+
│ └── Backlog/
|
|
102
|
+
│
|
|
103
|
+
├── 030-Specs/ # Technical Specs
|
|
104
|
+
│ ├── Specs-MOC.md # REQUIRED MOC
|
|
105
|
+
│ ├── Architecture/
|
|
106
|
+
│ ├── API/
|
|
107
|
+
│ └── Schema/
|
|
108
|
+
│
|
|
109
|
+
├── 035-QA/ # Quality Assurance
|
|
110
|
+
│ ├── QA-MOC.md # REQUIRED MOC
|
|
111
|
+
│ ├── Test-Plans/
|
|
112
|
+
│ ├── Test-Cases/
|
|
113
|
+
│ ├── Automation/
|
|
114
|
+
│ ├── Reports/
|
|
115
|
+
│ └── Performance/
|
|
116
|
+
│
|
|
117
|
+
├── 040-Design/ # UI/UX & Frontend
|
|
118
|
+
│ ├── Design-MOC.md # REQUIRED MOC
|
|
119
|
+
│ ├── Wireframes/
|
|
120
|
+
│ ├── Design-System/
|
|
121
|
+
│ ├── Specs/
|
|
122
|
+
│ └── Assets/
|
|
123
|
+
│
|
|
124
|
+
├── 050-Research/ # Discovery & Analysis
|
|
125
|
+
│ ├── Research-MOC.md # REQUIRED MOC
|
|
126
|
+
│ ├── Competitor-Analysis/
|
|
127
|
+
│ └── User-Interviews/
|
|
128
|
+
│
|
|
129
|
+
├── 060-Manuals/ # End-User Documentation
|
|
130
|
+
│ ├── Manuals-MOC.md # REQUIRED MOC
|
|
131
|
+
│ ├── User-Guide/
|
|
132
|
+
│ └── Admin-Guide/
|
|
133
|
+
│
|
|
134
|
+
├── 090-Archive/ # Deprecated docs (never delete)
|
|
135
|
+
│
|
|
136
|
+
└── 999-Resources/ # Templates, Scripts, Glossary
|
|
137
|
+
├── Templates/
|
|
138
|
+
├── Glossary.md
|
|
139
|
+
└── Meeting-Notes/
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Frontmatter Template
|
|
143
|
+
|
|
144
|
+
Every document MUST include this frontmatter:
|
|
145
|
+
|
|
146
|
+
```yaml
|
|
147
|
+
---
|
|
148
|
+
id: {TYPE}-{NNN} # Unique identifier (e.g., PRD-001, UC-01)
|
|
149
|
+
type: {document_type} # prd, brd, use-case, epic, story, spec, adr, etc.
|
|
150
|
+
status: draft|review|approved|deprecated
|
|
151
|
+
project: {project_name} # Optional: for multi-project docs
|
|
152
|
+
owner: "@{team_or_person}" # Optional: responsible party
|
|
153
|
+
tags: [tag1, tag2] # Optional: for search/filtering
|
|
154
|
+
linked-to: [[Related-Doc]] # Optional: primary relationship
|
|
155
|
+
created: YYYY-MM-DD
|
|
156
|
+
updated: YYYY-MM-DD # Optional: last update date
|
|
157
|
+
---
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Linking Rules
|
|
161
|
+
|
|
162
|
+
1. **PRD** → links to Epics it spawns: `## Related Epics\n- [[Epic-Feature1]]\n- [[Epic-Feature2]]`
|
|
163
|
+
2. **Epic** → links to parent PRD: `Implements: [[PRD-ProjectName]]`
|
|
164
|
+
3. **Use Case** → links to Epic: `Part of: [[Epic-Feature]]`
|
|
165
|
+
4. **SDD** → links to PRD: `Implements: [[PRD-ProjectName]]`
|
|
166
|
+
5. **ADR** → links to SDD: `Related to: [[SDD-ProjectName]]`
|
|
167
|
+
|
|
168
|
+
## Validation Checklist
|
|
169
|
+
|
|
170
|
+
Before finalizing any document, verify:
|
|
171
|
+
|
|
172
|
+
- [ ] Document is in correct `docs/XXX-Category/` folder
|
|
173
|
+
- [ ] Filename follows naming convention from mapping table
|
|
174
|
+
- [ ] Frontmatter includes required fields (id, type, status, created)
|
|
175
|
+
- [ ] Wiki-links to related documents are added
|
|
176
|
+
- [ ] Parent folder's MOC file is updated with link to new document
|
|
177
|
+
- [ ] 000-Index.md updated (for major documents like PRD, SDD)
|