From fd89fe2cef2ac1001de23abbde0587c3df75d65c Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:16:07 +0530 Subject: [PATCH 1/7] Add files via upload --- CONTRIBUTING.md | 401 ++++++++++++++++++++++ FAQ.md | 528 +++++++++++++++++++++++++++++ GETTING_STARTED.md | 201 +++++++++++ README.md | 27 ++ docs/EXAMPLES.md | 760 ++++++++++++++++++++++++++++++++++++++++++ docs/SKILL_ANATOMY.md | 545 ++++++++++++++++++++++++++++++ docs/VISUAL_GUIDE.md | 504 ++++++++++++++++++++++++++++ 7 files changed, 2966 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 FAQ.md create mode 100644 GETTING_STARTED.md create mode 100644 docs/EXAMPLES.md create mode 100644 docs/SKILL_ANATOMY.md create mode 100644 docs/VISUAL_GUIDE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ed75e8ed --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,401 @@ +# 🀝 Contributing Guide - Make It Easy for Everyone! + +**Thank you for wanting to make this repo better!** This guide shows you exactly how to contribute, even if you're new to open source. + +--- + +## 🎯 Ways to Contribute + +You don't need to be an expert! Here are ways anyone can help: + +### 1. πŸ“ Improve Documentation (Easiest!) +- Fix typos or grammar +- Make explanations clearer +- Add examples to existing skills +- Translate documentation to other languages + +### 2. πŸ› Report Issues +- Found something confusing? Tell us! +- Skill not working? Let us know! +- Have suggestions? We want to hear them! + +### 3. ✨ Create New Skills +- Share your expertise as a skill +- Fill gaps in the current collection +- Improve existing skills + +### 4. πŸ§ͺ Test and Validate +- Try skills and report what works/doesn't work +- Test on different AI tools +- Suggest improvements + +--- + +## πŸ“ How to Improve Documentation + +### Super Easy Method (No Git Knowledge Needed!) + +1. **Find the file** you want to improve on GitHub +2. **Click the pencil icon** (✏️) to edit +3. **Make your changes** in the browser +4. **Click "Propose changes"** at the bottom +5. **Done!** We'll review and merge it + +### Using Git (If You Know How) + +```bash +# 1. Fork the repo on GitHub (click the Fork button) + +# 2. Clone your fork +git clone https://github.com/YOUR-USERNAME/antigravity-awesome-skills.git +cd antigravity-awesome-skills + +# 3. Create a branch +git checkout -b improve-docs + +# 4. Make your changes +# Edit files in your favorite editor + +# 5. Commit and push +git add . +git commit -m "docs: make XYZ clearer" +git push origin improve-docs + +# 6. Open a Pull Request on GitHub +``` + +--- + +## ✨ How to Create a New Skill + +### What Makes a Good Skill? + +A skill should: +- βœ… Solve a specific problem +- βœ… Be reusable across projects +- βœ… Have clear instructions +- βœ… Include examples when possible + +### Step-by-Step: Create Your First Skill + +#### Step 1: Choose Your Skill Topic + +Ask yourself: +- What am I good at? +- What do I wish my AI assistant knew better? +- What task do I do repeatedly? + +**Examples:** +- "I'm good at Docker, let me create a Docker skill" +- "I wish AI understood Tailwind better" +- "I keep setting up the same testing patterns" + +#### Step 2: Create the Folder Structure + +```bash +# Navigate to the skills directory +cd skills/ + +# Create your skill folder (use lowercase with hyphens) +mkdir my-awesome-skill + +# Create the SKILL.md file +cd my-awesome-skill +touch SKILL.md +``` + +#### Step 3: Write Your SKILL.md + +Every skill needs this basic structure: + +```markdown +--- +name: my-awesome-skill +description: "Brief one-line description of what this skill does" +--- + +# Skill Title + +## Overview + +Explain what this skill does and when to use it. + +## When to Use This Skill + +- Use when [scenario 1] +- Use when [scenario 2] +- Use when [scenario 3] + +## How It Works + +### Step 1: [First Step] +Explain what to do first... + +### Step 2: [Second Step] +Explain the next step... + +### Step 3: [Final Step] +Explain how to finish... + +## Examples + +### Example 1: [Common Use Case] +\`\`\` +Show example code or commands here +\`\`\` + +### Example 2: [Another Use Case] +\`\`\` +More examples... +\`\`\` + +## Best Practices + +- βœ… Do this +- βœ… Also do this +- ❌ Don't do this +- ❌ Avoid this + +## Common Pitfalls + +- **Problem:** Description of common issue + **Solution:** How to fix it + +## Additional Resources + +- [Link to documentation](https://example.com) +- [Tutorial](https://example.com) +``` + +#### Step 4: Test Your Skill + +1. **Copy it to your AI tool's skills directory:** + ```bash + cp -r skills/my-awesome-skill ~/.agent/skills/ + ``` + +2. **Try using it:** + ``` + @my-awesome-skill help me with [task] + ``` + +3. **Does it work?** Great! If not, refine it. + +#### Step 5: Validate Your Skill + +Run the validation script: + +```bash +python3 scripts/validate_skills.py +``` + +This checks: +- βœ… SKILL.md exists +- βœ… Frontmatter is correct +- βœ… Name matches folder name +- βœ… Description exists + +#### Step 6: Submit Your Skill + +```bash +# 1. Add your skill +git add skills/my-awesome-skill/ + +# 2. Commit with a clear message +git commit -m "feat: add my-awesome-skill for [purpose]" + +# 3. Push to your fork +git push origin my-branch + +# 4. Open a Pull Request on GitHub +``` + +--- + +## 🎨 Skill Template (Copy & Paste) + +Save time! Copy this template: + +```markdown +--- +name: your-skill-name +description: "One sentence describing what this skill does and when to use it" +--- + +# Your Skill Name + +## Overview + +[2-3 sentences explaining what this skill does] + +## When to Use This Skill + +- Use when you need to [scenario 1] +- Use when you want to [scenario 2] +- Use when working with [scenario 3] + +## Core Concepts + +### Concept 1 +[Explain key concept] + +### Concept 2 +[Explain another key concept] + +## Step-by-Step Guide + +### 1. [First Step Name] +[Detailed instructions] + +### 2. [Second Step Name] +[Detailed instructions] + +### 3. [Third Step Name] +[Detailed instructions] + +## Examples + +### Example 1: [Use Case Name] +\`\`\`language +// Example code here +\`\`\` + +**Explanation:** [What this example demonstrates] + +### Example 2: [Another Use Case] +\`\`\`language +// More example code +\`\`\` + +**Explanation:** [What this example demonstrates] + +## Best Practices + +- βœ… **Do:** [Good practice] +- βœ… **Do:** [Another good practice] +- ❌ **Don't:** [What to avoid] +- ❌ **Don't:** [Another thing to avoid] + +## Troubleshooting + +### Problem: [Common Issue] +**Symptoms:** [How you know this is the problem] +**Solution:** [How to fix it] + +### Problem: [Another Issue] +**Symptoms:** [How you know this is the problem] +**Solution:** [How to fix it] + +## Related Skills + +- `@related-skill-1` - [When to use this instead] +- `@related-skill-2` - [How this complements your skill] + +## Additional Resources + +- [Official Documentation](https://example.com) +- [Tutorial](https://example.com) +- [Community Guide](https://example.com) +``` + +--- + +## πŸ› How to Report Issues + +### Found a Bug? + +1. **Check existing issues** - Maybe it's already reported +2. **Open a new issue** with this info: + - What skill has the problem? + - What AI tool are you using? + - What did you expect to happen? + - What actually happened? + - Steps to reproduce + +### Found Something Confusing? + +1. **Open an issue** titled: "Documentation unclear: [topic]" +2. **Explain:** + - What part is confusing? + - What did you expect to find? + - How could it be clearer? + +--- + +## βœ… Contribution Checklist + +Before submitting your contribution: + +- [ ] My skill has a clear, descriptive name +- [ ] The `SKILL.md` has proper frontmatter (name + description) +- [ ] I've included examples +- [ ] I've tested the skill with an AI assistant +- [ ] I've run `python3 scripts/validate_skills.py` +- [ ] My commit message is clear (e.g., "feat: add docker-compose skill") +- [ ] I've checked for typos and grammar + +--- + +## πŸ“‹ Commit Message Guidelines + +Use these prefixes: + +- `feat:` - New skill or major feature +- `docs:` - Documentation improvements +- `fix:` - Bug fixes +- `refactor:` - Code improvements without changing functionality +- `test:` - Adding or updating tests +- `chore:` - Maintenance tasks + +**Examples:** +``` +feat: add kubernetes-deployment skill +docs: improve getting started guide +fix: correct typo in stripe-integration skill +docs: add examples to react-best-practices +``` + +--- + +## πŸŽ“ Learning Resources + +### New to Git/GitHub? +- [GitHub's Hello World Guide](https://guides.github.com/activities/hello-world/) +- [Git Basics](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics) + +### New to Markdown? +- [Markdown Guide](https://www.markdownguide.org/basic-syntax/) +- [GitHub Markdown](https://guides.github.com/features/mastering-markdown/) + +### New to Open Source? +- [First Contributions](https://github.com/firstcontributions/first-contributions) +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) + +--- + +## πŸ’¬ Need Help? + +- **Questions?** Open a [Discussion](https://github.com/sickn33/antigravity-awesome-skills/discussions) +- **Stuck?** Open an [Issue](https://github.com/sickn33/antigravity-awesome-skills/issues) +- **Want feedback?** Open a [Draft Pull Request](https://github.com/sickn33/antigravity-awesome-skills/pulls) + +--- + +## 🌟 Recognition + +All contributors are recognized in our [Contributors](https://github.com/sickn33/antigravity-awesome-skills/graphs/contributors) page! + +--- + +## πŸ“œ Code of Conduct + +- Be respectful and inclusive +- Welcome newcomers +- Focus on constructive feedback +- Help others learn + +--- + +**Thank you for making this project better for everyone!** πŸ™Œ + +Every contribution, no matter how small, makes a difference. Whether you fix a typo, improve a sentence, or create a whole new skill - you're helping thousands of developers! πŸš€ diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 00000000..2ac7d1b5 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,528 @@ +# ❓ Frequently Asked Questions (FAQ) + +**Got questions?** You're not alone! Here are answers to the most common questions about Antigravity Awesome Skills. + +--- + +## 🎯 General Questions + +### What are "skills" exactly? + +Skills are specialized instruction files that teach AI assistants how to handle specific tasks. Think of them as expert knowledge modules that your AI can load on-demand. + +**Simple analogy:** Just like you might consult different experts (a lawyer, a doctor, a mechanic), skills let your AI become an expert in different areas when you need them. + +--- + +### Do I need to install all 179 skills? + +**No!** When you clone the repository, all skills are available, but your AI only loads them when you explicitly invoke them with `@skill-name` or `/skill-name`. + +It's like having a library - all the books are there, but you only read the ones you need. + +--- + +### Which AI tools work with these skills? + +These skills work with any AI coding assistant that supports the `SKILL.md` format: + +- βœ… **Claude Code** (Anthropic CLI) +- βœ… **Gemini CLI** (Google) +- βœ… **Codex CLI** (OpenAI) +- βœ… **Cursor** (AI IDE) +- βœ… **Antigravity IDE** +- βœ… **OpenCode** +- ⚠️ **GitHub Copilot** (partial support) + +--- + +### Are these skills free to use? + +**Yes!** This repository is licensed under MIT License, which means: +- βœ… Free for personal use +- βœ… Free for commercial use +- βœ… You can modify them +- βœ… You can redistribute them + +--- + +### Do skills work offline? + +The skill files themselves are stored locally on your computer, but your AI assistant needs an internet connection to function. So: +- βœ… Skills are local files +- ❌ AI assistant needs internet + +--- + +## πŸ› οΈ Installation & Setup + +### Where should I install the skills? + +The universal path that works with most tools is `.agent/skills/`: + +```bash +git clone https://github.com/sickn33/antigravity-awesome-skills.git .agent/skills +``` + +**Tool-specific paths:** +- Claude Code: `.claude/skills/` or `.agent/skills/` +- Gemini CLI: `.gemini/skills/` or `.agent/skills/` +- Cursor: `.cursor/skills/` or project root +- Antigravity: `.agent/skills/` + +--- + +### Can I install skills in multiple projects? + +**Yes!** You have two options: + +**Option 1: Global Installation** (recommended) +Install once in your home directory, works for all projects: +```bash +cd ~ +git clone https://github.com/sickn33/antigravity-awesome-skills.git .agent/skills +``` + +**Option 2: Per-Project Installation** +Install in each project directory: +```bash +cd /path/to/your/project +git clone https://github.com/sickn33/antigravity-awesome-skills.git .agent/skills +``` + +--- + +### How do I update skills to the latest version? + +Navigate to your skills directory and pull the latest changes: + +```bash +cd .agent/skills +git pull origin main +``` + +--- + +### Can I install only specific skills? + +**Yes!** You can manually copy individual skill folders: + +```bash +# Clone the full repo first +git clone https://github.com/sickn33/antigravity-awesome-skills.git temp-skills + +# Copy only the skills you want +mkdir -p .agent/skills +cp -r temp-skills/skills/brainstorming .agent/skills/ +cp -r temp-skills/skills/stripe-integration .agent/skills/ + +# Clean up +rm -rf temp-skills +``` + +--- + +## 🎯 Using Skills + +### How do I invoke a skill? + +Use the `@` symbol followed by the skill name: + +``` +@skill-name your request here +``` + +**Examples:** +``` +@brainstorming help me design a todo app +@stripe-integration add subscription billing +@systematic-debugging fix this test failure +``` + +Some tools also support `/skill-name` syntax. + +--- + +### How do I know which skill to use? + +**Method 1: Browse the README** +Check the [Full Skill Registry](README.md#full-skill-registry-179179) organized by category + +**Method 2: Search by keyword** +```bash +ls skills/ | grep "keyword" +``` + +**Method 3: Ask your AI** +``` +What skills are available for [topic]? +``` + +--- + +### Can I use multiple skills at once? + +**Yes!** You can invoke multiple skills in the same conversation: + +``` +@brainstorming help me design this feature + +[After brainstorming...] + +@test-driven-development now let's implement it with tests +``` + +--- + +### What if a skill doesn't work? + +**Troubleshooting steps:** + +1. **Check installation path** + ```bash + ls .agent/skills/ + ``` + +2. **Verify skill exists** + ```bash + ls .agent/skills/skill-name/ + ``` + +3. **Check SKILL.md exists** + ```bash + cat .agent/skills/skill-name/SKILL.md + ``` + +4. **Try restarting your AI assistant** + +5. **Check for typos in skill name** + - Use `@brainstorming` not `@brain-storming` + - Names are case-sensitive in some tools + +6. **Report the issue** + [Open an issue](https://github.com/sickn33/antigravity-awesome-skills/issues) with details + +--- + +## 🀝 Contributing + +### I'm new to open source. Can I still contribute? + +**Absolutely!** Everyone starts somewhere. We welcome contributions from beginners: + +- Fix typos or grammar +- Improve documentation clarity +- Add examples to existing skills +- Report issues or confusing parts + +Check out [CONTRIBUTING_GUIDE.md](CONTRIBUTING_GUIDE.md) for step-by-step instructions. + +--- + +### Do I need to know how to code to contribute? + +**No!** Many valuable contributions don't require coding: + +- **Documentation improvements** - Make things clearer +- **Examples** - Add real-world usage examples +- **Issue reporting** - Tell us what's confusing +- **Testing** - Try skills and report what works + +--- + +### How do I create a new skill? + +**Quick version:** + +1. Create a folder: `skills/my-skill-name/` +2. Create `SKILL.md` with frontmatter and content +3. Test it with your AI assistant +4. Run validation: `python3 scripts/validate_skills.py` +5. Submit a Pull Request + +**Detailed version:** See [CONTRIBUTING_GUIDE.md](CONTRIBUTING_GUIDE.md) + +--- + +### What makes a good skill? + +A good skill: +- βœ… Solves a specific problem +- βœ… Has clear, actionable instructions +- βœ… Includes examples +- βœ… Is reusable across projects +- βœ… Follows the standard structure + +See [SKILL_ANATOMY.md](docs/SKILL_ANATOMY.md) for details. + +--- + +### How long does it take for my contribution to be reviewed? + +Review times vary, but typically: +- **Simple fixes** (typos, docs): 1-3 days +- **New skills**: 3-7 days +- **Major changes**: 1-2 weeks + +You can speed this up by: +- Following the contribution guidelines +- Writing clear commit messages +- Testing your changes +- Responding to feedback quickly + +--- + +## πŸ”§ Technical Questions + +### What's the difference between SKILL.md and README.md? + +- **SKILL.md** (required): The actual skill definition that the AI reads +- **README.md** (optional): Human-readable documentation about the skill + +The AI primarily uses `SKILL.md`, while developers read `README.md`. + +--- + +### Can I use scripts or code in my skill? + +**Yes!** Skills can include: +- `scripts/` - Helper scripts +- `examples/` - Example code +- `templates/` - Code templates +- `references/` - Documentation + +Reference them in your `SKILL.md`: +```markdown +Run the setup script: +\`\`\`bash +bash scripts/setup.sh +\`\`\` +``` + +--- + +### What programming languages can skills cover? + +**Any language!** Current skills cover: +- JavaScript/TypeScript +- Python +- Go +- Rust +- Swift +- Kotlin +- Shell scripting +- And many more... + +--- + +### Can skills call other skills? + +**Yes!** Skills can reference other skills: + +```markdown +## Workflow + +1. First, use `@brainstorming` to design +2. Then, use `@writing-plans` to plan +3. Finally, use `@test-driven-development` to implement +``` + +--- + +### How do I validate my skill before submitting? + +Run the validation script: + +```bash +python3 scripts/validate_skills.py +``` + +This checks: +- βœ… SKILL.md exists +- βœ… Frontmatter is valid +- βœ… Name matches folder name +- βœ… Description exists + +--- + +## πŸŽ“ Learning & Best Practices + +### Which skills should I try first? + +**For beginners:** +- `@brainstorming` - Design before coding +- `@systematic-debugging` - Fix bugs methodically +- `@git-pushing` - Commit with good messages + +**For developers:** +- `@test-driven-development` - Write tests first +- `@react-best-practices` - Modern React patterns +- `@senior-fullstack` - Full-stack development + +**For security:** +- `@ethical-hacking-methodology` - Security basics +- `@burp-suite-testing` - Web app testing + +--- + +### How do I learn to write good skills? + +**Learning path:** + +1. **Read existing skills** - Study 5-10 well-written skills +2. **Use skills** - Try them with your AI assistant +3. **Read guides** - Check [SKILL_ANATOMY.md](docs/SKILL_ANATOMY.md) +4. **Start simple** - Create a basic skill first +5. **Get feedback** - Submit and learn from reviews +6. **Iterate** - Improve based on feedback + +**Recommended skills to study:** +- `skills/brainstorming/SKILL.md` - Clear structure +- `skills/systematic-debugging/SKILL.md` - Comprehensive +- `skills/git-pushing/SKILL.md` - Simple and focused + +--- + +### Are there any skills for learning AI/ML? + +**Yes!** Check out: +- `@rag-engineer` - RAG systems +- `@prompt-engineering` - Prompt design +- `@langgraph` - Multi-agent systems +- `@ai-agents-architect` - Agent architecture +- `@llm-app-patterns` - LLM application patterns + +--- + +## πŸ› Troubleshooting + +### My AI assistant doesn't recognize skills + +**Possible causes:** + +1. **Wrong installation path** + - Check your tool's documentation for the correct path + - Try `.agent/skills/` as the universal path + +2. **Skill name typo** + - Verify the exact skill name: `ls .agent/skills/` + - Use the exact name from the folder + +3. **Tool doesn't support skills** + - Verify your tool supports the SKILL.md format + - Check the [Compatibility](#-compatibility) section + +4. **Need to restart** + - Restart your AI assistant after installing skills + +--- + +### A skill gives incorrect or outdated advice + +**Please report it!** + +1. [Open an issue](https://github.com/sickn33/antigravity-awesome-skills/issues) +2. Include: + - Which skill + - What's incorrect + - What should it say instead + - Links to correct documentation + +We'll update it quickly! + +--- + +### Can I modify skills for my own use? + +**Yes!** The MIT License allows you to: +- βœ… Modify skills for your needs +- βœ… Create private versions +- βœ… Customize for your team + +**To modify:** +1. Copy the skill to a new location +2. Edit the SKILL.md file +3. Use your modified version + +**Consider contributing improvements back!** + +--- + +## πŸ“Š Statistics & Info + +### How many skills are there? + +**179 skills** across 10+ categories as of the latest update. + +--- + +### How often are skills updated? + +- **Bug fixes**: As soon as reported +- **New skills**: Added regularly by contributors +- **Updates**: When best practices change + +**Stay updated:** +```bash +cd .agent/skills +git pull origin main +``` + +--- + +### Who maintains this repository? + +This is a community-driven project with contributions from: +- Original creators +- Open source contributors +- AI coding assistant users worldwide + +See [Credits & Sources](README.md#credits--sources) for attribution. + +--- + +## πŸ†˜ Still Have Questions? + +### Where can I get help? + +- πŸ’¬ **[GitHub Discussions](https://github.com/sickn33/antigravity-awesome-skills/discussions)** - Ask questions +- πŸ› **[GitHub Issues](https://github.com/sickn33/antigravity-awesome-skills/issues)** - Report bugs +- πŸ“– **Documentation** - Read the guides in this repo +- 🀝 **Community** - Connect with other users + +--- + +### How can I stay updated? + +- ⭐ **Star the repository** on GitHub +- πŸ‘€ **Watch the repository** for updates +- πŸ“§ **Subscribe to releases** for notifications +- 🐦 **Follow contributors** on social media + +--- + +### Can I use these skills commercially? + +**Yes!** The MIT License permits commercial use. You can: +- βœ… Use in commercial projects +- βœ… Use in client work +- βœ… Include in paid products +- βœ… Modify for commercial purposes + +**Only requirement:** Keep the license notice. + +--- + +## πŸ’‘ Pro Tips + +- Start with `@brainstorming` before building anything new +- Use `@systematic-debugging` when stuck on bugs +- Try `@test-driven-development` for better code quality +- Explore `@skill-creator` to make your own skills +- Read skill descriptions to understand when to use them + +--- + +**Question not answered?** + +[Open a discussion](https://github.com/sickn33/antigravity-awesome-skills/discussions) and we'll help you out! πŸ™Œ diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md new file mode 100644 index 00000000..8e7f278e --- /dev/null +++ b/GETTING_STARTED.md @@ -0,0 +1,201 @@ +# πŸš€ Getting Started with Antigravity Awesome Skills + +**New here? This guide will help you understand and use this repository in 5 minutes!** + +--- + +## πŸ€” What Are "Skills"? + +Think of skills as **specialized instruction manuals** for AI coding assistants. + +**Simple analogy:** Just like you might hire different experts (a designer, a security expert, a marketer), these skills let your AI assistant become an expert in specific areas when you need them. + +--- + +## πŸ“¦ What's Inside This Repository? + +This repo contains **179 ready-to-use skills** organized in the `skills/` folder. Each skill is a folder with at least one file: `SKILL.md` + +``` +skills/ +β”œβ”€β”€ brainstorming/ +β”‚ └── SKILL.md ← The skill definition +β”œβ”€β”€ stripe-integration/ +β”‚ └── SKILL.md +β”œβ”€β”€ react-best-practices/ +β”‚ └── SKILL.md +└── ... (176 more skills) +``` + +--- + +## 🎯 How Do Skills Work? + +### Step 1: Install Skills +Copy the skills to your AI tool's directory: + +```bash +# For most AI tools (Claude Code, Gemini CLI, etc.) +git clone https://github.com/sickn33/antigravity-awesome-skills.git .agent/skills +``` + +### Step 2: Use a Skill +In your AI chat, mention the skill: + +``` +@brainstorming help me design a todo app +``` + +or + +``` +/stripe-integration add payment processing to my app +``` + +### Step 3: The AI Becomes an Expert +The AI loads that skill's knowledge and helps you with specialized expertise! + +--- + +## πŸ› οΈ Which AI Tools Work With This? + +| Tool | Works? | Installation Path | +|------|--------|-------------------| +| **Claude Code** | βœ… Yes | `.claude/skills/` or `.agent/skills/` | +| **Gemini CLI** | βœ… Yes | `.gemini/skills/` or `.agent/skills/` | +| **Cursor** | βœ… Yes | `.cursor/skills/` | +| **GitHub Copilot** | ⚠️ Partial | Copy to `.github/copilot/` | +| **Antigravity IDE** | βœ… Yes | `.agent/skills/` | + +--- + +## πŸ“š Skill Categories (Simplified) + +### 🎨 **Creative & Design** (10 skills) +Make beautiful things: UI design, art, themes, web components +- Try: `@frontend-design`, `@canvas-design`, `@ui-ux-pro-max` + +### πŸ› οΈ **Development** (25 skills) +Write better code: testing, debugging, React patterns, architecture +- Try: `@test-driven-development`, `@systematic-debugging`, `@react-best-practices` + +### πŸ›‘οΈ **Security** (50 skills) +Ethical hacking and penetration testing tools +- Try: `@ethical-hacking-methodology`, `@burp-suite-testing` + +### πŸ€– **AI & Agents** (30 skills) +Build AI apps: RAG, LangGraph, prompt engineering, voice agents +- Try: `@rag-engineer`, `@prompt-engineering`, `@langgraph` + +### πŸ“„ **Documents** (4 skills) +Work with Word, Excel, PowerPoint, PDF files +- Try: `@docx-official`, `@xlsx-official`, `@pdf-official` + +### πŸ“ˆ **Marketing** (23 skills) +Grow your product: SEO, copywriting, ads, email campaigns +- Try: `@copywriting`, `@seo-audit`, `@page-cro` + +### πŸ”Œ **Integrations** (25 skills) +Connect to services: Stripe, Firebase, Twilio, Discord, Slack +- Try: `@stripe-integration`, `@firebase`, `@clerk-auth` + +--- + +## πŸŽ“ Your First Skill: A Quick Example + +Let's try the **brainstorming** skill: + +1. **Open your AI assistant** (Claude Code, Cursor, etc.) + +2. **Type this:** + ``` + @brainstorming I want to build a simple weather app + ``` + +3. **What happens:** + - The AI loads the brainstorming skill + - It asks you questions one at a time + - It helps you design the app before coding + - It creates a design document for you + +4. **Result:** You get a well-thought-out plan instead of jumping straight to code! + +--- + +## πŸ” How to Find the Right Skill + +### Method 1: Browse by Category +Check the [Full Skill Registry](README.md#full-skill-registry-179179) in the main README + +### Method 2: Search by Keyword +Use your file explorer or terminal: +```bash +# Find skills related to "testing" +ls skills/ | grep test + +# Find skills related to "auth" +ls skills/ | grep auth +``` + +### Method 3: Look at the Index +Check `skills_index.json` for a machine-readable list + +--- + +## 🀝 Want to Contribute? + +Great! Here's how: + +### Option 1: Improve Documentation +- Make READMEs clearer +- Add more examples +- Fix typos or confusing parts + +### Option 2: Create a New Skill +See our [CONTRIBUTING_GUIDE.md](CONTRIBUTING_GUIDE.md) for step-by-step instructions + +### Option 3: Report Issues +Found something confusing? [Open an issue](https://github.com/sickn33/antigravity-awesome-skills/issues) + +--- + +## ❓ Common Questions + +### Q: Do I need to install all 179 skills? +**A:** No! Clone the whole repo, and your AI will only load skills when you use them. + +### Q: Can I create my own skills? +**A:** Yes! Check out the `@skill-creator` skill or read [CONTRIBUTING_GUIDE.md](CONTRIBUTING_GUIDE.md) + +### Q: What if my AI tool isn't listed? +**A:** If it supports the `SKILL.md` format, try `.agent/skills/` - it's the universal path. + +### Q: Are these skills free? +**A:** Yes! MIT License. Use them however you want. + +### Q: Do skills work offline? +**A:** The skill files are local, but your AI assistant needs internet to function. + +--- + +## πŸŽ‰ Next Steps + +1. βœ… Install the skills in your AI tool +2. βœ… Try 2-3 skills from different categories +3. βœ… Read [CONTRIBUTING_GUIDE.md](CONTRIBUTING_GUIDE.md) if you want to help +4. βœ… Star the repo if you find it useful! ⭐ + +--- + +## πŸ’‘ Pro Tips + +- **Start with `@brainstorming`** before building anything new +- **Use `@systematic-debugging`** when you're stuck on a bug +- **Try `@test-driven-development`** to write better code +- **Explore `@skill-creator`** to make your own skills + +--- + +**Still confused?** Open an issue and we'll help you out! πŸ™Œ + +**Ready to dive deeper?** Check out the main [README.md](README.md) for the complete skill list. diff --git a/README.md b/README.md index d3a0e2aa..65e3bfce 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ This repository provides essential skills to transform your AI assistant into a ## πŸ“ Table of Contents +- [πŸš€ New Here? Start Here!](#-new-here-start-here) - [πŸ”Œ Compatibility](#-compatibility) - [Features & Categories](#features--categories) - [Full Skill Registry](#full-skill-registry-155155) @@ -35,6 +36,32 @@ This repository provides essential skills to transform your AI assistant into a --- +## New Here? Start Here! + +**First time using this repository?** We've created beginner-friendly guides to help you get started: + +- **[GETTING_STARTED.md](GETTING_STARTED.md)** - Complete beginner's guide (5-minute read) +- **[CONTRIBUTING_GUIDE.md](CONTRIBUTING_GUIDE.md)** - How to contribute (step-by-step) +- **[SKILL_ANATOMY.md](docs/SKILL_ANATOMY.md)** - Understanding how skills work +- **[QUICK_START_VISUAL.md](docs/QUICK_START_VISUAL.md)** - Visual guide with diagrams + +**Quick Start:** +```bash +# 1. Install skills +git clone https://github.com/sickn33/antigravity-awesome-skills.git .agent/skills + +# 2. Use a skill in your AI assistant +@brainstorming help me design a todo app +``` + +That's it! Your AI assistant now has 179 specialized skills. πŸŽ‰ + +**Additional Resources:** +- πŸ’‘ **[Real-World Examples](docs/EXAMPLES.md)** - See skills in action +- ❓ **[FAQ](FAQ.md)** - Common questions answered + +--- + ## πŸ”Œ Compatibility These skills follow the universal **SKILL.md** format and work with any AI coding assistant that supports agentic skills: diff --git a/docs/EXAMPLES.md b/docs/EXAMPLES.md new file mode 100644 index 00000000..fd4ced99 --- /dev/null +++ b/docs/EXAMPLES.md @@ -0,0 +1,760 @@ +# πŸ’‘ Real-World Examples - See Skills in Action + +**Learn by example!** This guide shows you real conversations using different skills. + +--- + +## 🎨 Example 1: Designing a Feature with @brainstorming + +### The Scenario +You want to add a "dark mode" feature to your app, but you're not sure how to approach it. + +### The Conversation + +``` +You: @brainstorming I want to add dark mode to my React app + +AI: Great! Let me help you think through this. First, let me check your + current project structure... + + [AI examines your files] + + I see you're using React with Tailwind CSS. Now, let's understand + your requirements: + + What's your primary goal for dark mode? + a) User preference (toggle in settings) + b) System preference (follow OS setting) + c) Both (with manual override) + +You: c) Both + +AI: Perfect! That's the best user experience. Next question: + + Where should the dark mode toggle be located? + a) In the main navigation + b) In a settings page + c) In a dropdown menu + d) Multiple locations + +You: a) In the main navigation + +AI: Good choice for accessibility. One more question: + + Should dark mode preference persist across sessions? + a) Yes, save to localStorage + b) Yes, save to user account (requires backend) + c) No, reset each session + +You: a) Yes, save to localStorage + +AI: Excellent! Now I have a clear picture. Let me present the design... + + ## Dark Mode Implementation Design + + ### Architecture Overview + We'll use React Context for state management, Tailwind's dark mode + utilities, and localStorage for persistence. The system will: + 1. Check OS preference on first visit + 2. Allow manual override via toggle + 3. Persist preference in localStorage + + Does this approach look good so far? + +You: Yes, continue + +AI: [Continues with detailed design sections...] + + [After design is complete] + + I've saved the design to docs/plans/2026-01-20-dark-mode-design.md + + Ready to set up for implementation? + +You: Yes + +AI: I'll create an isolated workspace using git worktrees and write an + implementation plan. One moment... +``` + +### What Happened +- βœ… AI asked focused questions one at a time +- βœ… Explored your specific context +- βœ… Presented design in sections +- βœ… Saved documentation +- βœ… Prepared for implementation + +--- + +## πŸ› Example 2: Debugging with @systematic-debugging + +### The Scenario +Your tests are failing, but you're not sure why. + +### The Conversation + +``` +You: @systematic-debugging My tests are failing with "Cannot read property + 'map' of undefined" + +AI: Let me help you debug this systematically. First, I'll gather information: + + 1. Running the failing test to see the full error... + + [AI runs: npm test] + + I see the error occurs in UserList.test.tsx at line 45. Let me examine + the test file and the component... + + [AI reads both files] + + ## Hypothesis + The test is failing because `users` prop is undefined when the component + renders. This suggests the mock data isn't being passed correctly. + + ## Verification + Let me check the test setup... + + [AI examines test] + + Found it! The test is calling: + ```typescript + render() + ``` + + But UserList requires a `users` prop. The component expects: + ```typescript + interface UserListProps { + users: User[]; + } + ``` + + ## Solution + The test should pass the users prop: + ```typescript + const mockUsers = [ + { id: 1, name: 'Alice' }, + { id: 2, name: 'Bob' } + ]; + + render() + ``` + + Should I apply this fix? + +You: Yes + +AI: [Applies fix and runs tests] + + βœ… All tests passing! + + ## Root Cause + The test was missing required props. This is a common issue when + components are refactored to require props that were previously optional. + + ## Prevention + Consider adding TypeScript strict mode to catch these at compile time: + ```json + "strict": true, + "strictNullChecks": true + ``` + + Would you like me to add this to your tsconfig.json? +``` + +### What Happened +- βœ… Systematic investigation +- βœ… Clear hypothesis +- βœ… Verification before fixing +- βœ… Root cause analysis +- βœ… Prevention suggestions + +--- + +## πŸ’³ Example 3: Adding Payments with @stripe-integration + +### The Scenario +You need to add subscription billing to your SaaS app. + +### The Conversation + +``` +You: @stripe-integration I need to add monthly subscription billing + +AI: I'll help you implement Stripe subscriptions. Let me understand your + requirements: + + Current stack detected: + - Next.js 14 (App Router) + - TypeScript + - Prisma with PostgreSQL + + For subscription billing, we'll need: + + 1. **Stripe Setup** + - Stripe account and API keys + - Webhook endpoint for events + - Product and price IDs + + 2. **Backend Implementation** + - API routes for checkout + - Webhook handler + - Database schema for subscriptions + + 3. **Frontend Implementation** + - Pricing page + - Checkout flow + - Subscription management + + Let's start with the backend. First, install dependencies: + + ```bash + npm install stripe @stripe/stripe-js + ``` + + Now, let's create the database schema... + + [AI provides Prisma schema] + + ```prisma + model User { + id String @id @default(cuid()) + email String @unique + stripeCustomerId String? @unique + subscriptions Subscription[] + } + + model Subscription { + id String @id @default(cuid()) + userId String + user User @relation(fields: [userId], references: [id]) + stripeSubscriptionId String @unique + status String + priceId String + currentPeriodEnd DateTime + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt + } + ``` + + Next, let's create the checkout API route... + + [AI provides complete implementation with:] + - API route for creating checkout sessions + - Webhook handler for subscription events + - Helper functions for Stripe operations + - Error handling and logging + - TypeScript types + + Now for the frontend... + + [AI provides:] + - Pricing page component + - Checkout button component + - Subscription status display + - Tailwind styling + + Finally, let's set up the webhook: + + 1. In Stripe Dashboard, add webhook endpoint: + `https://yourdomain.com/api/webhooks/stripe` + + 2. Select these events: + - customer.subscription.created + - customer.subscription.updated + - customer.subscription.deleted + - invoice.payment_succeeded + - invoice.payment_failed + + 3. Copy the webhook secret to your .env: + ``` + STRIPE_WEBHOOK_SECRET=whsec_... + ``` + + ## Testing + + Test locally with Stripe CLI: + ```bash + stripe listen --forward-to localhost:3000/api/webhooks/stripe + stripe trigger customer.subscription.created + ``` + + ## Security Checklist + - βœ… API keys in environment variables + - βœ… Webhook signature verification + - βœ… Server-side price validation + - βœ… Idempotency keys for operations + + Ready to test the implementation? +``` + +### What Happened +- βœ… Detected existing stack +- βœ… Provided complete implementation +- βœ… Included database schema +- βœ… Added security best practices +- βœ… Included testing instructions + +--- + +## ✍️ Example 4: Writing Copy with @copywriting + +### The Scenario +You need compelling copy for your SaaS landing page. + +### The Conversation + +``` +You: @copywriting Write homepage copy for my project management tool + +AI: I'll help you create compelling homepage copy. First, let me understand + your product: + + What makes your project management tool different from competitors + like Asana, Trello, or Monday.com? + +You: It's specifically built for remote teams with built-in video standups + and async communication features + +AI: Excellent differentiator! Who is your primary target audience? + a) Startups and small teams (2-20 people) + b) Mid-size companies (20-200 people) + c) Enterprise (200+ people) + d) Freelancers and agencies + +You: a) Startups and small teams + +AI: Perfect. What's the main pain point you solve? + +You: Remote teams waste time in unnecessary meetings and lose context + in async communication + +AI: Great! Now I have what I need. Here's your homepage copy: + + --- + + ## Hero Section + + **Headline:** + Run Your Remote Team Without the Meeting Overload + + **Subheadline:** + The project management tool built for distributed teams. Replace + status meetings with async video standups and keep everyone in sync + without the Zoom fatigue. + + **CTA:** + Start Free Trial β†’ (No credit card required) + + --- + + ## Problem Section + + **Headline:** + Remote Work Shouldn't Mean More Meetings + + **Body:** + Your team is distributed across time zones. You're spending hours in + status meetings just to stay aligned. Async updates get lost in Slack. + Context disappears. Productivity suffers. + + Sound familiar? + + --- + + ## Solution Section + + **Headline:** + Stay Aligned Without the Meeting Marathon + + **Features:** + + πŸ“Ή **Async Video Standups** + Record quick video updates on your schedule. Your team watches when + it works for them. No more 9am calls for your teammate in Tokyo. + + πŸ’¬ **Context-Rich Communication** + Every task, comment, and decision stays connected. No more hunting + through Slack threads or email chains. + + πŸ“Š **Visual Progress Tracking** + See what's happening at a glance. Kanban boards, timelines, and + dashboards that actually make sense. + + πŸ”” **Smart Notifications** + Get notified about what matters. Ignore the rest. Your focus time + is sacred. + + --- + + ## Social Proof Section + + **Headline:** + Trusted by Remote Teams Worldwide + + [Testimonial placeholders with structure] + + --- + + ## CTA Section + + **Headline:** + Ready to Reclaim Your Calendar? + + **Body:** + Join 500+ remote teams who've cut meeting time by 60% while staying + more aligned than ever. + + **CTA:** + Start Your Free 14-Day Trial β†’ + + No credit card required. Cancel anytime. + + --- + + ## Copy Notes + + **Tone:** Professional but conversational + **Focus:** Pain point (too many meetings) β†’ Solution (async video) + **Differentiation:** Built specifically for remote teams + **Social proof:** Quantified benefit (60% fewer meetings) + + Would you like me to: + 1. Write alternative versions for A/B testing? + 2. Create copy for specific feature pages? + 3. Write email sequences for onboarding? +``` + +### What Happened +- βœ… Asked clarifying questions +- βœ… Identified unique value proposition +- βœ… Created benefit-focused copy +- βœ… Included clear CTAs +- βœ… Provided copy notes for consistency + +--- + +## πŸ§ͺ Example 5: Test-Driven Development with @test-driven-development + +### The Scenario +You need to implement a new feature: user authentication. + +### The Conversation + +``` +You: @test-driven-development I need to implement user login functionality + +AI: Perfect! Let's use TDD to build this. Following the Red-Green-Refactor + cycle, we'll write tests first, then implement. + + ## Step 1: Write the First Test (RED) + + Let's start with the simplest case - successful login: + + ```typescript + // auth.test.ts + import { login } from './auth'; + + describe('login', () => { + it('should return user data for valid credentials', async () => { + const result = await login({ + email: 'user@example.com', + password: 'correct-password' + }); + + expect(result.success).toBe(true); + expect(result.user).toHaveProperty('id'); + expect(result.user).toHaveProperty('email'); + expect(result.token).toBeDefined(); + }); + }); + ``` + + Let's run this test to see it fail: + + [AI runs: npm test] + + βœ… Test fails as expected (auth.ts doesn't exist yet) + + ## Step 2: Write Minimal Implementation (GREEN) + + Now let's write just enough code to make this test pass: + + ```typescript + // auth.ts + interface LoginCredentials { + email: string; + password: string; + } + + interface LoginResult { + success: boolean; + user?: { + id: string; + email: string; + }; + token?: string; + } + + export async function login( + credentials: LoginCredentials + ): Promise { + // Minimal implementation to pass the test + return { + success: true, + user: { + id: '1', + email: credentials.email + }, + token: 'fake-token' + }; + } + ``` + + [AI runs: npm test] + + βœ… Test passes! + + ## Step 3: Add Next Test (RED) + + Now let's test the failure case: + + ```typescript + it('should return error for invalid credentials', async () => { + const result = await login({ + email: 'user@example.com', + password: 'wrong-password' + }); + + expect(result.success).toBe(false); + expect(result.error).toBe('Invalid credentials'); + expect(result.user).toBeUndefined(); + expect(result.token).toBeUndefined(); + }); + ``` + + [AI runs: npm test] + + ❌ Test fails (always returns success) + + ## Step 4: Implement Real Logic (GREEN) + + Now let's add actual authentication: + + ```typescript + import bcrypt from 'bcrypt'; + import jwt from 'jsonwebtoken'; + import { db } from './db'; + + export async function login( + credentials: LoginCredentials + ): Promise { + // Find user + const user = await db.user.findUnique({ + where: { email: credentials.email } + }); + + if (!user) { + return { + success: false, + error: 'Invalid credentials' + }; + } + + // Verify password + const validPassword = await bcrypt.compare( + credentials.password, + user.passwordHash + ); + + if (!validPassword) { + return { + success: false, + error: 'Invalid credentials' + }; + } + + // Generate token + const token = jwt.sign( + { userId: user.id }, + process.env.JWT_SECRET!, + { expiresIn: '7d' } + ); + + return { + success: true, + user: { + id: user.id, + email: user.email + }, + token + }; + } + ``` + + [AI runs: npm test] + + βœ… All tests pass! + + ## Step 5: Add Edge Cases + + Let's add more tests for edge cases: + + ```typescript + it('should handle missing email', async () => { + const result = await login({ + email: '', + password: 'password' + }); + + expect(result.success).toBe(false); + expect(result.error).toBe('Email is required'); + }); + + it('should handle missing password', async () => { + const result = await login({ + email: 'user@example.com', + password: '' + }); + + expect(result.success).toBe(false); + expect(result.error).toBe('Password is required'); + }); + + it('should handle database errors gracefully', async () => { + // Mock database error + jest.spyOn(db.user, 'findUnique').mockRejectedValue( + new Error('Database connection failed') + ); + + const result = await login({ + email: 'user@example.com', + password: 'password' + }); + + expect(result.success).toBe(false); + expect(result.error).toBe('An error occurred'); + }); + ``` + + [AI implements validation and error handling] + + ## Step 6: Refactor (REFACTOR) + + Now that all tests pass, let's refactor for better code quality: + + ```typescript + // Extract validation + function validateCredentials(credentials: LoginCredentials): string | null { + if (!credentials.email) return 'Email is required'; + if (!credentials.password) return 'Password is required'; + return null; + } + + // Extract user verification + async function verifyUser( + email: string, + password: string + ): Promise { + const user = await db.user.findUnique({ where: { email } }); + if (!user) return null; + + const valid = await bcrypt.compare(password, user.passwordHash); + return valid ? user : null; + } + + // Main function is now cleaner + export async function login( + credentials: LoginCredentials + ): Promise { + try { + const validationError = validateCredentials(credentials); + if (validationError) { + return { success: false, error: validationError }; + } + + const user = await verifyUser( + credentials.email, + credentials.password + ); + + if (!user) { + return { success: false, error: 'Invalid credentials' }; + } + + const token = generateToken(user.id); + + return { + success: true, + user: { id: user.id, email: user.email }, + token + }; + } catch (error) { + console.error('Login error:', error); + return { success: false, error: 'An error occurred' }; + } + } + ``` + + [AI runs: npm test] + + βœ… All tests still pass after refactoring! + + ## Summary + + We've implemented login functionality using TDD: + - βœ… 5 tests covering happy path, errors, and edge cases + - βœ… Clean, testable code + - βœ… Proper error handling + - βœ… Type safety with TypeScript + + Next steps: + 1. Add rate limiting tests + 2. Add session management tests + 3. Add logout functionality + + Should I continue with these? +``` + +### What Happened +- βœ… Followed Red-Green-Refactor cycle +- βœ… Wrote tests before implementation +- βœ… Covered edge cases +- βœ… Refactored with confidence +- βœ… Maintained test coverage + +--- + +## 🎯 Key Takeaways + +### What Makes These Examples Effective? + +1. **Skills ask clarifying questions** before jumping to solutions +2. **Skills provide context-aware help** based on your project +3. **Skills follow best practices** for their domain +4. **Skills include complete examples** not just snippets +5. **Skills explain the "why"** not just the "how" + +### How to Get Similar Results + +1. **Be specific** in your requests +2. **Provide context** about your project +3. **Answer questions** the skill asks +4. **Review suggestions** before applying +5. **Iterate** based on results + +--- + +## πŸš€ Try These Yourself! + +Pick a skill and try it with your own project: + +- **Planning:** `@brainstorming` or `@writing-plans` +- **Development:** `@test-driven-development` or `@react-best-practices` +- **Debugging:** `@systematic-debugging` or `@test-fixing` +- **Integration:** `@stripe-integration` or `@firebase` +- **Marketing:** `@copywriting` or `@seo-audit` + +--- + +**Want more examples?** Check individual skill folders for additional examples and use cases! diff --git a/docs/SKILL_ANATOMY.md b/docs/SKILL_ANATOMY.md new file mode 100644 index 00000000..872c0ea6 --- /dev/null +++ b/docs/SKILL_ANATOMY.md @@ -0,0 +1,545 @@ +# πŸ”¬ Anatomy of a Skill - Understanding the Structure + +**Want to understand how skills work under the hood?** This guide breaks down every part of a skill file. + +--- + +## πŸ“ Basic Folder Structure + +``` +skills/ +└── my-skill-name/ + β”œβ”€β”€ SKILL.md ← Required: The main skill definition + β”œβ”€β”€ examples/ ← Optional: Example files + β”‚ β”œβ”€β”€ example1.js + β”‚ └── example2.py + β”œβ”€β”€ scripts/ ← Optional: Helper scripts + β”‚ └── helper.sh + β”œβ”€β”€ templates/ ← Optional: Code templates + β”‚ └── template.tsx + β”œβ”€β”€ references/ ← Optional: Reference documentation + β”‚ └── api-docs.md + └── README.md ← Optional: Additional documentation +``` + +**Key Rule:** Only `SKILL.md` is required. Everything else is optional! + +--- + +## πŸ“„ SKILL.md Structure + +Every `SKILL.md` file has two main parts: + +### 1. Frontmatter (Metadata) +### 2. Content (Instructions) + +Let's break down each part: + +--- + +## 🏷️ Part 1: Frontmatter + +The frontmatter is at the very top, wrapped in `---`: + +```markdown +--- +name: my-skill-name +description: "Brief description of what this skill does" +--- +``` + +### Required Fields + +#### `name` +- **What it is:** The skill's identifier +- **Format:** lowercase-with-hyphens +- **Must match:** The folder name exactly +- **Example:** `stripe-integration` + +#### `description` +- **What it is:** One-sentence summary +- **Format:** String in quotes +- **Length:** Keep it under 150 characters +- **Example:** `"Stripe payment integration patterns including checkout, subscriptions, and webhooks"` + +### Optional Fields + +Some skills include additional metadata: + +```markdown +--- +name: my-skill-name +description: "Brief description" +version: "1.0.0" +author: "Your Name" +tags: ["react", "typescript", "testing"] +--- +``` + +--- + +## πŸ“ Part 2: Content + +After the frontmatter comes the actual skill content. Here's the recommended structure: + +### Recommended Sections + +#### 1. Title (H1) +```markdown +# Skill Title +``` +- Use a clear, descriptive title +- Usually matches or expands on the skill name + +#### 2. Overview +```markdown +## Overview + +A brief explanation of what this skill does and why it exists. +2-4 sentences is perfect. +``` + +#### 3. When to Use +```markdown +## When to Use This Skill + +- Use when you need to [scenario 1] +- Use when working with [scenario 2] +- Use when the user asks about [scenario 3] +``` + +**Why this matters:** Helps the AI know when to activate this skill + +#### 4. Core Instructions +```markdown +## How It Works + +### Step 1: [Action] +Detailed instructions... + +### Step 2: [Action] +More instructions... +``` + +**This is the heart of your skill** - clear, actionable steps + +#### 5. Examples +```markdown +## Examples + +### Example 1: [Use Case] +\`\`\`javascript +// Example code +\`\`\` + +### Example 2: [Another Use Case] +\`\`\`javascript +// More code +\`\`\` +``` + +**Why examples matter:** They show the AI exactly what good output looks like + +#### 6. Best Practices +```markdown +## Best Practices + +- βœ… Do this +- βœ… Also do this +- ❌ Don't do this +- ❌ Avoid this +``` + +#### 7. Common Pitfalls +```markdown +## Common Pitfalls + +- **Problem:** Description + **Solution:** How to fix it +``` + +#### 8. Related Skills +```markdown +## Related Skills + +- `@other-skill` - When to use this instead +- `@complementary-skill` - How this works together +``` + +--- + +## 🎯 Writing Effective Instructions + +### Use Clear, Direct Language + +**❌ Bad:** +```markdown +You might want to consider possibly checking if the user has authentication. +``` + +**βœ… Good:** +```markdown +Check if the user is authenticated before proceeding. +``` + +### Use Action Verbs + +**❌ Bad:** +```markdown +The file should be created... +``` + +**βœ… Good:** +```markdown +Create the file... +``` + +### Be Specific + +**❌ Bad:** +```markdown +Set up the database properly. +``` + +**βœ… Good:** +```markdown +1. Create a PostgreSQL database +2. Run migrations: `npm run migrate` +3. Seed initial data: `npm run seed` +``` + +--- + +## 🧩 Optional Components + +### Scripts Directory + +If your skill needs helper scripts: + +``` +scripts/ +β”œβ”€β”€ setup.sh ← Setup automation +β”œβ”€β”€ validate.py ← Validation tools +└── generate.js ← Code generators +``` + +**Reference them in SKILL.md:** +```markdown +Run the setup script: +\`\`\`bash +bash scripts/setup.sh +\`\`\` +``` + +### Examples Directory + +Real-world examples that demonstrate the skill: + +``` +examples/ +β”œβ”€β”€ basic-usage.js +β”œβ”€β”€ advanced-pattern.ts +└── full-implementation/ + β”œβ”€β”€ index.js + └── config.json +``` + +### Templates Directory + +Reusable code templates: + +``` +templates/ +β”œβ”€β”€ component.tsx +β”œβ”€β”€ test.spec.ts +└── config.json +``` + +**Reference in SKILL.md:** +```markdown +Use this template as a starting point: +\`\`\`typescript +{{#include templates/component.tsx}} +\`\`\` +``` + +### References Directory + +External documentation or API references: + +``` +references/ +β”œβ”€β”€ api-docs.md +β”œβ”€β”€ best-practices.md +└── troubleshooting.md +``` + +--- + +## πŸ“ Skill Size Guidelines + +### Minimum Viable Skill +- **Frontmatter:** name + description +- **Content:** 100-200 words +- **Sections:** Overview + Instructions + +### Standard Skill +- **Frontmatter:** name + description +- **Content:** 300-800 words +- **Sections:** Overview + When to Use + Instructions + Examples + +### Comprehensive Skill +- **Frontmatter:** name + description + optional fields +- **Content:** 800-2000 words +- **Sections:** All recommended sections +- **Extras:** Scripts, examples, templates + +**Rule of thumb:** Start small, expand based on feedback + +--- + +## 🎨 Formatting Best Practices + +### Use Markdown Effectively + +#### Code Blocks +Always specify the language: +```markdown +\`\`\`javascript +const example = "code"; +\`\`\` +``` + +#### Lists +Use consistent formatting: +```markdown +- Item 1 +- Item 2 + - Sub-item 2.1 + - Sub-item 2.2 +``` + +#### Emphasis +- **Bold** for important terms: `**important**` +- *Italic* for emphasis: `*emphasis*` +- `Code` for commands/code: `` `code` `` + +#### Links +```markdown +[Link text](https://example.com) +``` + +--- + +## βœ… Quality Checklist + +Before finalizing your skill: + +### Content Quality +- [ ] Instructions are clear and actionable +- [ ] Examples are realistic and helpful +- [ ] No typos or grammar errors +- [ ] Technical accuracy verified + +### Structure +- [ ] Frontmatter is valid YAML +- [ ] Name matches folder name +- [ ] Sections are logically organized +- [ ] Headings follow hierarchy (H1 β†’ H2 β†’ H3) + +### Completeness +- [ ] Overview explains the "why" +- [ ] Instructions explain the "how" +- [ ] Examples show the "what" +- [ ] Edge cases are addressed + +### Usability +- [ ] A beginner could follow this +- [ ] An expert would find it useful +- [ ] The AI can parse it correctly +- [ ] It solves a real problem + +--- + +## πŸ” Real-World Example Analysis + +Let's analyze a real skill: `brainstorming` + +```markdown +--- +name: brainstorming +description: "You MUST use this before any creative work..." +--- +``` + +**Analysis:** +- βœ… Clear name +- βœ… Strong description with urgency ("MUST use") +- βœ… Explains when to use it + +```markdown +# Brainstorming Ideas Into Designs + +## Overview +Help turn ideas into fully formed designs... +``` + +**Analysis:** +- βœ… Clear title +- βœ… Concise overview +- βœ… Explains the value proposition + +```markdown +## The Process + +**Understanding the idea:** +- Check out the current project state first +- Ask questions one at a time +``` + +**Analysis:** +- βœ… Broken into clear phases +- βœ… Specific, actionable steps +- βœ… Easy to follow + +--- + +## πŸš€ Advanced Patterns + +### Conditional Logic + +```markdown +## Instructions + +If the user is working with React: +- Use functional components +- Prefer hooks over class components + +If the user is working with Vue: +- Use Composition API +- Follow Vue 3 patterns +``` + +### Progressive Disclosure + +```markdown +## Basic Usage +[Simple instructions for common cases] + +## Advanced Usage +[Complex patterns for power users] +``` + +### Cross-References + +```markdown +## Related Workflows + +1. First, use `@brainstorming` to design +2. Then, use `@writing-plans` to plan +3. Finally, use `@test-driven-development` to implement +``` + +--- + +## πŸ“Š Skill Effectiveness Metrics + +How to know if your skill is good: + +### Clarity Test +- Can someone unfamiliar with the topic follow it? +- Are there any ambiguous instructions? + +### Completeness Test +- Does it cover the happy path? +- Does it handle edge cases? +- Are error scenarios addressed? + +### Usefulness Test +- Does it solve a real problem? +- Would you use this yourself? +- Does it save time or improve quality? + +--- + +## πŸŽ“ Learning from Existing Skills + +### Study These Examples + +**For Beginners:** +- `skills/brainstorming/SKILL.md` - Clear structure +- `skills/git-pushing/SKILL.md` - Simple and focused +- `skills/copywriting/SKILL.md` - Good examples + +**For Advanced:** +- `skills/systematic-debugging/SKILL.md` - Comprehensive +- `skills/react-best-practices/SKILL.md` - Multiple files +- `skills/loki-mode/SKILL.md` - Complex workflows + +--- + +## πŸ’‘ Pro Tips + +1. **Start with the "When to Use" section** - This clarifies the skill's purpose +2. **Write examples first** - They help you understand what you're teaching +3. **Test with an AI** - See if it actually works before submitting +4. **Get feedback** - Ask others to review your skill +5. **Iterate** - Skills improve over time based on usage + +--- + +## πŸ†˜ Common Mistakes to Avoid + +### ❌ Mistake 1: Too Vague +```markdown +## Instructions +Make the code better. +``` + +**βœ… Fix:** +```markdown +## Instructions +1. Extract repeated logic into functions +2. Add error handling for edge cases +3. Write unit tests for core functionality +``` + +### ❌ Mistake 2: Too Complex +```markdown +## Instructions +[5000 words of dense technical jargon] +``` + +**βœ… Fix:** +Break into multiple skills or use progressive disclosure + +### ❌ Mistake 3: No Examples +```markdown +## Instructions +[Instructions without any code examples] +``` + +**βœ… Fix:** +Add at least 2-3 realistic examples + +### ❌ Mistake 4: Outdated Information +```markdown +Use React class components... +``` + +**βœ… Fix:** +Keep skills updated with current best practices + +--- + +## 🎯 Next Steps + +1. **Read 3-5 existing skills** to see different styles +2. **Try the skill template** from CONTRIBUTING_GUIDE.md +3. **Create a simple skill** for something you know well +4. **Test it** with your AI assistant +5. **Share it** via Pull Request + +--- + +**Remember:** Every expert was once a beginner. Start simple, learn from feedback, and improve over time! πŸš€ diff --git a/docs/VISUAL_GUIDE.md b/docs/VISUAL_GUIDE.md new file mode 100644 index 00000000..c54a3961 --- /dev/null +++ b/docs/VISUAL_GUIDE.md @@ -0,0 +1,504 @@ +# 🎨 Visual Quick Start Guide + +**Learn by seeing!** This guide uses diagrams and visual examples to help you understand skills. + +--- + +## πŸ—ΊοΈ The Big Picture + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ YOU (Developer) β”‚ +β”‚ ↓ β”‚ +β”‚ "Help me build a payment system" β”‚ +β”‚ ↓ β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ AI ASSISTANT β”‚ +β”‚ ↓ β”‚ +β”‚ Loads @stripe-integration skill β”‚ +β”‚ ↓ β”‚ +β”‚ Becomes an expert in Stripe payments β”‚ +β”‚ ↓ β”‚ +β”‚ Provides specialized help with code examples β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸ“¦ Repository Structure (Visual) + +``` +antigravity-awesome-skills/ +β”‚ +β”œβ”€β”€ πŸ“„ README.md ← Overview & skill list +β”œβ”€β”€ πŸ“„ GETTING_STARTED.md ← Start here! (NEW) +β”œβ”€β”€ πŸ“„ CONTRIBUTING_GUIDE.md ← How to contribute (NEW) +β”‚ +β”œβ”€β”€ πŸ“ skills/ ← All 179 skills live here +β”‚ β”‚ +β”‚ β”œβ”€β”€ πŸ“ brainstorming/ +β”‚ β”‚ └── πŸ“„ SKILL.md ← Skill definition +β”‚ β”‚ +β”‚ β”œβ”€β”€ πŸ“ stripe-integration/ +β”‚ β”‚ β”œβ”€β”€ πŸ“„ SKILL.md +β”‚ β”‚ └── πŸ“ examples/ ← Optional extras +β”‚ β”‚ +β”‚ β”œβ”€β”€ πŸ“ react-best-practices/ +β”‚ β”‚ β”œβ”€β”€ πŸ“„ SKILL.md +β”‚ β”‚ β”œβ”€β”€ πŸ“ rules/ +β”‚ β”‚ └── πŸ“„ README.md +β”‚ β”‚ +β”‚ └── ... (176 more skills) +β”‚ +β”œβ”€β”€ πŸ“ scripts/ ← Validation & management +β”‚ β”œβ”€β”€ 🐍 validate_skills.py +β”‚ └── 🐍 generate_index.py +β”‚ +└── πŸ“ docs/ ← Documentation (NEW) + β”œβ”€β”€ πŸ“„ SKILL_ANATOMY.md ← How skills work + └── πŸ“„ QUICK_START_VISUAL.md ← This file! +``` + +--- + +## πŸ”„ How Skills Work (Flow Diagram) + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 1. INSTALL β”‚ Copy skills to .agent/skills/ +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 2. INVOKE β”‚ Type: @skill-name in AI chat +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 3. LOAD β”‚ AI reads SKILL.md file +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 4. EXECUTE β”‚ AI follows skill instructions +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 5. RESULT β”‚ You get specialized help! +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## 🎯 Skill Categories (Visual Map) + +``` + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ 179 AWESOME SKILLS β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ β”‚ + β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” + β”‚ CREATIVEβ”‚ β”‚ DEVELOPMENT β”‚ β”‚ SECURITY β”‚ + β”‚ (10) β”‚ β”‚ (25) β”‚ β”‚ (50) β”‚ + β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ + β”‚ β”‚ β”‚ + β€’ UI/UX Design β€’ TDD β€’ Ethical Hacking + β€’ Canvas Art β€’ Debugging β€’ Metasploit + β€’ Themes β€’ React Patterns β€’ Burp Suite + β€’ SQLMap + β”‚ β”‚ β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ β”‚ + β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” + β”‚ AI β”‚ β”‚ DOCUMENTS β”‚ β”‚ MARKETING β”‚ + β”‚ (30) β”‚ β”‚ (4) β”‚ β”‚ (23) β”‚ + β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ + β”‚ β”‚ β”‚ + β€’ RAG Systems β€’ DOCX β€’ SEO + β€’ LangGraph β€’ PDF β€’ Copywriting + β€’ Prompt Eng. β€’ PPTX β€’ CRO + β€’ Voice Agents β€’ XLSX β€’ Paid Ads +``` + +--- + +## πŸ“ Skill File Anatomy (Visual) + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ SKILL.md β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ FRONTMATTER (Metadata) β”‚ β”‚ +β”‚ β”‚ ───────────────────────────────────────────── β”‚ β”‚ +β”‚ β”‚ --- β”‚ β”‚ +β”‚ β”‚ name: my-skill β”‚ β”‚ +β”‚ β”‚ description: "What this skill does" β”‚ β”‚ +β”‚ β”‚ --- β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ CONTENT (Instructions) β”‚ β”‚ +β”‚ β”‚ ───────────────────────────────────────────── β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ # Skill Title β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ ## Overview β”‚ β”‚ +β”‚ β”‚ What this skill does... β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ ## When to Use β”‚ β”‚ +β”‚ β”‚ - Use when... β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ ## Instructions β”‚ β”‚ +β”‚ β”‚ 1. First step... β”‚ β”‚ +β”‚ β”‚ 2. Second step... β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ ## Examples β”‚ β”‚ +β”‚ β”‚ ```javascript β”‚ β”‚ +β”‚ β”‚ // Example code β”‚ β”‚ +β”‚ β”‚ ``` β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸš€ Installation (Visual Steps) + +### Step 1: Clone the Repository +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Terminal β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ $ git clone https://github.com/ β”‚ +β”‚ sickn33/antigravity-awesome-skills β”‚ +β”‚ .agent/skills β”‚ +β”‚ β”‚ +β”‚ βœ“ Cloning into '.agent/skills'... β”‚ +β”‚ βœ“ Done! β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +### Step 2: Verify Installation +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ File Explorer β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ πŸ“ .agent/ β”‚ +β”‚ └── πŸ“ skills/ β”‚ +β”‚ β”œβ”€β”€ πŸ“ brainstorming/ β”‚ +β”‚ β”œβ”€β”€ πŸ“ stripe-integration/ β”‚ +β”‚ β”œβ”€β”€ πŸ“ react-best-practices/ β”‚ +β”‚ └── ... (176 more) β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +### Step 3: Use a Skill +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ AI Assistant Chat β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ You: @brainstorming help me design β”‚ +β”‚ a todo app β”‚ +β”‚ β”‚ +β”‚ AI: Great! Let me help you think β”‚ +β”‚ through this. First, let's β”‚ +β”‚ understand your requirements... β”‚ +β”‚ β”‚ +β”‚ What's the primary use case? β”‚ +β”‚ a) Personal task management β”‚ +β”‚ b) Team collaboration β”‚ +β”‚ c) Project planning β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸŽ“ Example: Using a Skill (Step-by-Step) + +### Scenario: You want to add Stripe payments to your app + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ STEP 1: Identify the Need β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ "I need to add payment processing to my app" β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ STEP 2: Find the Right Skill β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ Search: "payment" or "stripe" β”‚ +β”‚ Found: @stripe-integration β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ STEP 3: Invoke the Skill β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ You: @stripe-integration help me add subscription billing β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ STEP 4: AI Loads Skill Knowledge β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ β€’ Stripe API patterns β”‚ +β”‚ β€’ Webhook handling β”‚ +β”‚ β€’ Subscription management β”‚ +β”‚ β€’ Best practices β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ STEP 5: Get Expert Help β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ AI provides: β”‚ +β”‚ β€’ Code examples β”‚ +β”‚ β€’ Setup instructions β”‚ +β”‚ β€’ Security considerations β”‚ +β”‚ β€’ Testing strategies β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸ” Finding Skills (Visual Guide) + +### Method 1: Browse by Category +``` +README.md β†’ Scroll to "Full Skill Registry" β†’ Find category β†’ Pick skill +``` + +### Method 2: Search by Keyword +``` +Terminal β†’ ls skills/ | grep "keyword" β†’ See matching skills +``` + +### Method 3: Use the Index +``` +Open skills_index.json β†’ Search for keyword β†’ Find skill path +``` + +--- + +## πŸ› οΈ Creating Your First Skill (Visual Workflow) + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 1. IDEA β”‚ "I want to share my Docker knowledge" +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 2. CREATE β”‚ mkdir skills/docker-mastery +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ touch skills/docker-mastery/SKILL.md + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 3. WRITE β”‚ Add frontmatter + content +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ (Use template from CONTRIBUTING_GUIDE.md) + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 4. TEST β”‚ Copy to .agent/skills/ +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ Try: @docker-mastery + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 5. VALIDATE β”‚ python3 scripts/validate_skills.py +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 6. SUBMIT β”‚ git commit + push + Pull Request +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸ“Š Skill Complexity Levels + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ SKILL COMPLEXITY β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ β”‚ +β”‚ SIMPLE STANDARD COMPLEX β”‚ +β”‚ ────── ──────── ─────── β”‚ +β”‚ β”‚ +β”‚ β€’ 1 file β€’ 1 file β€’ Multiple β”‚ +β”‚ β€’ 100-200 words β€’ 300-800 words β€’ 800-2000 β”‚ +β”‚ β€’ Basic structure β€’ Full structure β€’ Scripts β”‚ +β”‚ β€’ No extras β€’ Examples β€’ Examples β”‚ +β”‚ β€’ Best practices β€’ Templatesβ”‚ +β”‚ β€’ Docs β”‚ +β”‚ Example: Example: Example: β”‚ +β”‚ git-pushing brainstorming loki-mode β”‚ +β”‚ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## 🎯 Contribution Impact (Visual) + +``` +Your Contribution + β”‚ + β”œβ”€β†’ Improves Documentation + β”‚ β”‚ + β”‚ └─→ Helps 1000s of developers understand + β”‚ + β”œβ”€β†’ Creates New Skill + β”‚ β”‚ + β”‚ └─→ Enables new capabilities for everyone + β”‚ + β”œβ”€β†’ Fixes Bug/Typo + β”‚ β”‚ + β”‚ └─→ Prevents confusion for future users + β”‚ + └─→ Adds Example + β”‚ + └─→ Makes learning easier for beginners +``` + +--- + +## πŸ—ΊοΈ Learning Path (Visual Roadmap) + +``` +START HERE + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Read β”‚ +β”‚ GETTING_STARTED β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Try 2-3 Skills β”‚ +β”‚ in AI Assistant β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Read β”‚ +β”‚ SKILL_ANATOMY β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Study Existing β”‚ +β”‚ Skills β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Create Simple β”‚ +β”‚ Skill β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Read β”‚ +β”‚ CONTRIBUTING β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Submit PR β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + ↓ + CONTRIBUTOR! πŸŽ‰ +``` + +--- + +## πŸ’‘ Quick Tips (Visual Cheatsheet) + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ QUICK REFERENCE β”‚ +β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ +β”‚ β”‚ +β”‚ πŸ“₯ INSTALL β”‚ +β”‚ git clone [repo] .agent/skills β”‚ +β”‚ β”‚ +β”‚ 🎯 USE β”‚ +β”‚ @skill-name [your request] β”‚ +β”‚ β”‚ +β”‚ πŸ” FIND β”‚ +β”‚ ls skills/ | grep "keyword" β”‚ +β”‚ β”‚ +β”‚ βœ… VALIDATE β”‚ +β”‚ python3 scripts/validate_skills.py β”‚ +β”‚ β”‚ +β”‚ πŸ“ CREATE β”‚ +β”‚ 1. mkdir skills/my-skill β”‚ +β”‚ 2. Create SKILL.md with frontmatter β”‚ +β”‚ 3. Add content β”‚ +β”‚ 4. Test & validate β”‚ +β”‚ 5. Submit PR β”‚ +β”‚ β”‚ +β”‚ πŸ†˜ HELP β”‚ +β”‚ β€’ GETTING_STARTED.md - Basics β”‚ +β”‚ β€’ CONTRIBUTING_GUIDE.md - How to contribute β”‚ +β”‚ β€’ SKILL_ANATOMY.md - Deep dive β”‚ +β”‚ β€’ GitHub Issues - Ask questions β”‚ +β”‚ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸŽ‰ Success Stories (Visual Timeline) + +``` +Day 1: Install skills + β”‚ + └─→ "Wow, @brainstorming helped me design my app!" + +Day 3: Use 5 different skills + β”‚ + └─→ "These skills save me so much time!" + +Week 1: Create first skill + β”‚ + └─→ "I shared my expertise as a skill!" + +Week 2: Skill gets merged + β”‚ + └─→ "My skill is helping others! πŸŽ‰" + +Month 1: Regular contributor + β”‚ + └─→ "I've contributed 5 skills and improved docs!" +``` + +--- + +## πŸš€ Next Steps + +1. βœ… **Understand** the visual structure +2. βœ… **Install** skills in your AI tool +3. βœ… **Try** 2-3 skills from different categories +4. βœ… **Read** CONTRIBUTING_GUIDE.md +5. βœ… **Create** your first skill +6. βœ… **Share** with the community + +--- + +**Visual learner?** This guide should help! Still have questions? Check out: +- [GETTING_STARTED.md](../GETTING_STARTED.md) - Text-based intro +- [SKILL_ANATOMY.md](SKILL_ANATOMY.md) - Detailed breakdown +- [CONTRIBUTING_GUIDE.md](../CONTRIBUTING_GUIDE.md) - How to contribute + +**Ready to contribute?** You've got this! πŸ’ͺ From f2730b8ca414356b9a24e349869bd9e086b824e4 Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:28:50 +0530 Subject: [PATCH 2/7] Standardize section headers in CONTRIBUTING.md --- CONTRIBUTING.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed75e8ed..a43b0252 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,34 +4,34 @@ --- -## 🎯 Ways to Contribute +## Ways to Contribute You don't need to be an expert! Here are ways anyone can help: -### 1. πŸ“ Improve Documentation (Easiest!) +### 1. Improve Documentation (Easiest!) - Fix typos or grammar - Make explanations clearer - Add examples to existing skills - Translate documentation to other languages -### 2. πŸ› Report Issues +### 2. Report Issues - Found something confusing? Tell us! - Skill not working? Let us know! - Have suggestions? We want to hear them! -### 3. ✨ Create New Skills +### 3. Create New Skills - Share your expertise as a skill - Fill gaps in the current collection - Improve existing skills -### 4. πŸ§ͺ Test and Validate +### 4. Test and Validate - Try skills and report what works/doesn't work - Test on different AI tools - Suggest improvements --- -## πŸ“ How to Improve Documentation +## How to Improve Documentation ### Super Easy Method (No Git Knowledge Needed!) @@ -66,7 +66,7 @@ git push origin improve-docs --- -## ✨ How to Create a New Skill +## How to Create a New Skill ### What Makes a Good Skill? @@ -212,7 +212,7 @@ git push origin my-branch --- -## 🎨 Skill Template (Copy & Paste) +## Skill Template (Copy & Paste) Save time! Copy this template: @@ -300,7 +300,7 @@ description: "One sentence describing what this skill does and when to use it" --- -## πŸ› How to Report Issues +## How to Report Issues ### Found a Bug? @@ -322,7 +322,7 @@ description: "One sentence describing what this skill does and when to use it" --- -## βœ… Contribution Checklist +## Contribution Checklist Before submitting your contribution: @@ -336,7 +336,7 @@ Before submitting your contribution: --- -## πŸ“‹ Commit Message Guidelines +## Commit Message Guidelines Use these prefixes: @@ -357,7 +357,7 @@ docs: add examples to react-best-practices --- -## πŸŽ“ Learning Resources +## Learning Resources ### New to Git/GitHub? - [GitHub's Hello World Guide](https://guides.github.com/activities/hello-world/) @@ -373,7 +373,7 @@ docs: add examples to react-best-practices --- -## πŸ’¬ Need Help? +## Need Help? - **Questions?** Open a [Discussion](https://github.com/sickn33/antigravity-awesome-skills/discussions) - **Stuck?** Open an [Issue](https://github.com/sickn33/antigravity-awesome-skills/issues) @@ -381,13 +381,13 @@ docs: add examples to react-best-practices --- -## 🌟 Recognition +## Recognition All contributors are recognized in our [Contributors](https://github.com/sickn33/antigravity-awesome-skills/graphs/contributors) page! --- -## πŸ“œ Code of Conduct +## Code of Conduct - Be respectful and inclusive - Welcome newcomers @@ -396,6 +396,6 @@ All contributors are recognized in our [Contributors](https://github.com/sickn33 --- -**Thank you for making this project better for everyone!** πŸ™Œ +**Thank you for making this project better for everyone!** -Every contribution, no matter how small, makes a difference. Whether you fix a typo, improve a sentence, or create a whole new skill - you're helping thousands of developers! πŸš€ +Every contribution, no matter how small, makes a difference. Whether you fix a typo, improve a sentence, or create a whole new skill - you're helping thousands of developers! From ce0115da830b063c3988c3b76fa00a7fef041783 Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:30:40 +0530 Subject: [PATCH 3/7] Remove emojis from GETTING_STARTED.md headings --- GETTING_STARTED.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 8e7f278e..9c4b646d 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -1,4 +1,4 @@ -# πŸš€ Getting Started with Antigravity Awesome Skills +# Getting Started with Antigravity Awesome Skills **New here? This guide will help you understand and use this repository in 5 minutes!** @@ -29,7 +29,7 @@ skills/ --- -## 🎯 How Do Skills Work? +## How Do Skills Work? ### Step 1: Install Skills Copy the skills to your AI tool's directory: @@ -57,7 +57,7 @@ The AI loads that skill's knowledge and helps you with specialized expertise! --- -## πŸ› οΈ Which AI Tools Work With This? +## Which AI Tools Work With This? | Tool | Works? | Installation Path | |------|--------|-------------------| @@ -69,39 +69,39 @@ The AI loads that skill's knowledge and helps you with specialized expertise! --- -## πŸ“š Skill Categories (Simplified) +## Skill Categories (Simplified) -### 🎨 **Creative & Design** (10 skills) +### **Creative & Design** (10 skills) Make beautiful things: UI design, art, themes, web components - Try: `@frontend-design`, `@canvas-design`, `@ui-ux-pro-max` -### πŸ› οΈ **Development** (25 skills) +### **Development** (25 skills) Write better code: testing, debugging, React patterns, architecture - Try: `@test-driven-development`, `@systematic-debugging`, `@react-best-practices` -### πŸ›‘οΈ **Security** (50 skills) +### **Security** (50 skills) Ethical hacking and penetration testing tools - Try: `@ethical-hacking-methodology`, `@burp-suite-testing` -### πŸ€– **AI & Agents** (30 skills) +### **AI & Agents** (30 skills) Build AI apps: RAG, LangGraph, prompt engineering, voice agents - Try: `@rag-engineer`, `@prompt-engineering`, `@langgraph` -### πŸ“„ **Documents** (4 skills) +### **Documents** (4 skills) Work with Word, Excel, PowerPoint, PDF files - Try: `@docx-official`, `@xlsx-official`, `@pdf-official` -### πŸ“ˆ **Marketing** (23 skills) +### **Marketing** (23 skills) Grow your product: SEO, copywriting, ads, email campaigns - Try: `@copywriting`, `@seo-audit`, `@page-cro` -### πŸ”Œ **Integrations** (25 skills) +### **Integrations** (25 skills) Connect to services: Stripe, Firebase, Twilio, Discord, Slack - Try: `@stripe-integration`, `@firebase`, `@clerk-auth` --- -## πŸŽ“ Your First Skill: A Quick Example +## Your First Skill: A Quick Example Let's try the **brainstorming** skill: @@ -122,7 +122,7 @@ Let's try the **brainstorming** skill: --- -## πŸ” How to Find the Right Skill +## How to Find the Right Skill ### Method 1: Browse by Category Check the [Full Skill Registry](README.md#full-skill-registry-179179) in the main README @@ -178,7 +178,7 @@ Found something confusing? [Open an issue](https://github.com/sickn33/antigravit --- -## πŸŽ‰ Next Steps +## Next Steps 1. βœ… Install the skills in your AI tool 2. βœ… Try 2-3 skills from different categories From f42fcec4c1c8676a53f78c445ebbbdb34838bf47 Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:32:59 +0530 Subject: [PATCH 4/7] Update section headings in FAQ.md --- FAQ.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/FAQ.md b/FAQ.md index 2ac7d1b5..76170b47 100644 --- a/FAQ.md +++ b/FAQ.md @@ -54,7 +54,7 @@ The skill files themselves are stored locally on your computer, but your AI assi --- -## πŸ› οΈ Installation & Setup +## Installation & Setup ### Where should I install the skills? @@ -122,7 +122,7 @@ rm -rf temp-skills --- -## 🎯 Using Skills +## Using Skills ### How do I invoke a skill? @@ -272,7 +272,7 @@ You can speed this up by: --- -## πŸ”§ Technical Questions +## Technical Questions ### What's the difference between SKILL.md and README.md? @@ -345,7 +345,7 @@ This checks: --- -## πŸŽ“ Learning & Best Practices +## Learning & Best Practices ### Which skills should I try first? @@ -394,7 +394,7 @@ This checks: --- -## πŸ› Troubleshooting +## Troubleshooting ### My AI assistant doesn't recognize skills @@ -448,7 +448,7 @@ We'll update it quickly! --- -## πŸ“Š Statistics & Info +## Statistics & Info ### How many skills are there? @@ -481,23 +481,23 @@ See [Credits & Sources](README.md#credits--sources) for attribution. --- -## πŸ†˜ Still Have Questions? +## Still Have Questions? ### Where can I get help? -- πŸ’¬ **[GitHub Discussions](https://github.com/sickn33/antigravity-awesome-skills/discussions)** - Ask questions -- πŸ› **[GitHub Issues](https://github.com/sickn33/antigravity-awesome-skills/issues)** - Report bugs -- πŸ“– **Documentation** - Read the guides in this repo -- 🀝 **Community** - Connect with other users +- **[GitHub Discussions](https://github.com/sickn33/antigravity-awesome-skills/discussions)** - Ask questions +- **[GitHub Issues](https://github.com/sickn33/antigravity-awesome-skills/issues)** - Report bugs +- **Documentation** - Read the guides in this repo +- **Community** - Connect with other users --- ### How can I stay updated? -- ⭐ **Star the repository** on GitHub -- πŸ‘€ **Watch the repository** for updates -- πŸ“§ **Subscribe to releases** for notifications -- 🐦 **Follow contributors** on social media +- **Star the repository** on GitHub +- **Watch the repository** for updates +- **Subscribe to releases** for notifications +- **Follow contributors** on social media --- From 382f404ab24b97119ab1ea45aca66154b60dfaee Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:34:07 +0530 Subject: [PATCH 5/7] Remove emojis from example section headers --- docs/EXAMPLES.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/EXAMPLES.md b/docs/EXAMPLES.md index fd4ced99..ca9b9936 100644 --- a/docs/EXAMPLES.md +++ b/docs/EXAMPLES.md @@ -4,7 +4,7 @@ --- -## 🎨 Example 1: Designing a Feature with @brainstorming +## Example 1: Designing a Feature with @brainstorming ### The Scenario You want to add a "dark mode" feature to your app, but you're not sure how to approach it. @@ -86,7 +86,7 @@ AI: I'll create an isolated workspace using git worktrees and write an --- -## πŸ› Example 2: Debugging with @systematic-debugging +## Example 2: Debugging with @systematic-debugging ### The Scenario Your tests are failing, but you're not sure why. @@ -171,7 +171,7 @@ AI: [Applies fix and runs tests] --- -## πŸ’³ Example 3: Adding Payments with @stripe-integration +## Example 3: Adding Payments with @stripe-integration ### The Scenario You need to add subscription billing to your SaaS app. @@ -297,7 +297,7 @@ AI: I'll help you implement Stripe subscriptions. Let me understand your --- -## ✍️ Example 4: Writing Copy with @copywriting +## Example 4: Writing Copy with @copywriting ### The Scenario You need compelling copy for your SaaS landing page. @@ -434,7 +434,7 @@ AI: Great! Now I have what I need. Here's your homepage copy: --- -## πŸ§ͺ Example 5: Test-Driven Development with @test-driven-development +## Example 5: Test-Driven Development with @test-driven-development ### The Scenario You need to implement a new feature: user authentication. @@ -725,7 +725,7 @@ AI: Perfect! Let's use TDD to build this. Following the Red-Green-Refactor --- -## 🎯 Key Takeaways +## Key Takeaways ### What Makes These Examples Effective? @@ -745,7 +745,7 @@ AI: Perfect! Let's use TDD to build this. Following the Red-Green-Refactor --- -## πŸš€ Try These Yourself! +## Try These Yourself! Pick a skill and try it with your own project: From 99660f850dc80439edc77adbcac9b4e4c7d52482 Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:35:36 +0530 Subject: [PATCH 6/7] Remove emoji from SKILL_ANATOMY.md headings --- docs/SKILL_ANATOMY.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/SKILL_ANATOMY.md b/docs/SKILL_ANATOMY.md index 872c0ea6..73bf2660 100644 --- a/docs/SKILL_ANATOMY.md +++ b/docs/SKILL_ANATOMY.md @@ -1,4 +1,4 @@ -# πŸ”¬ Anatomy of a Skill - Understanding the Structure +# Anatomy of a Skill - Understanding the Structure **Want to understand how skills work under the hood?** This guide breaks down every part of a skill file. @@ -26,7 +26,7 @@ skills/ --- -## πŸ“„ SKILL.md Structure +## SKILL.md Structure Every `SKILL.md` file has two main parts: @@ -37,7 +37,7 @@ Let's break down each part: --- -## 🏷️ Part 1: Frontmatter +## Part 1: Frontmatter The frontmatter is at the very top, wrapped in `---`: @@ -78,7 +78,7 @@ tags: ["react", "typescript", "testing"] --- -## πŸ“ Part 2: Content +## Part 2: Content After the frontmatter comes the actual skill content. Here's the recommended structure: @@ -168,7 +168,7 @@ More instructions... --- -## 🎯 Writing Effective Instructions +## Writing Effective Instructions ### Use Clear, Direct Language @@ -210,7 +210,7 @@ Set up the database properly. --- -## 🧩 Optional Components +## Optional Components ### Scripts Directory @@ -276,7 +276,7 @@ references/ --- -## πŸ“ Skill Size Guidelines +## Skill Size Guidelines ### Minimum Viable Skill - **Frontmatter:** name + description @@ -298,7 +298,7 @@ references/ --- -## 🎨 Formatting Best Practices +## Formatting Best Practices ### Use Markdown Effectively @@ -404,7 +404,7 @@ Help turn ideas into fully formed designs... --- -## πŸš€ Advanced Patterns +## Advanced Patterns ### Conditional Logic @@ -442,7 +442,7 @@ If the user is working with Vue: --- -## πŸ“Š Skill Effectiveness Metrics +## Skill Effectiveness Metrics How to know if your skill is good: @@ -462,7 +462,7 @@ How to know if your skill is good: --- -## πŸŽ“ Learning from Existing Skills +## Learning from Existing Skills ### Study These Examples @@ -488,7 +488,7 @@ How to know if your skill is good: --- -## πŸ†˜ Common Mistakes to Avoid +## Common Mistakes to Avoid ### ❌ Mistake 1: Too Vague ```markdown From a138e75c87d6fee39f11857bc8ad7922b89a846f Mon Sep 17 00:00:00 2001 From: Mohammad Faiz Date: Tue, 20 Jan 2026 05:37:13 +0530 Subject: [PATCH 7/7] Remove emojis from Visual Quick Start Guide --- docs/VISUAL_GUIDE.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/VISUAL_GUIDE.md b/docs/VISUAL_GUIDE.md index c54a3961..5cffda8c 100644 --- a/docs/VISUAL_GUIDE.md +++ b/docs/VISUAL_GUIDE.md @@ -1,10 +1,10 @@ -# 🎨 Visual Quick Start Guide +# Visual Quick Start Guide **Learn by seeing!** This guide uses diagrams and visual examples to help you understand skills. --- -## πŸ—ΊοΈ The Big Picture +## The Big Picture ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” @@ -51,8 +51,8 @@ antigravity-awesome-skills/ β”‚ └── ... (176 more skills) β”‚ β”œβ”€β”€ πŸ“ scripts/ ← Validation & management -β”‚ β”œβ”€β”€ 🐍 validate_skills.py -β”‚ └── 🐍 generate_index.py +β”‚ β”œβ”€β”€ validate_skills.py +β”‚ └── generate_index.py β”‚ └── πŸ“ docs/ ← Documentation (NEW) β”œβ”€β”€ πŸ“„ SKILL_ANATOMY.md ← How skills work @@ -61,7 +61,7 @@ antigravity-awesome-skills/ --- -## πŸ”„ How Skills Work (Flow Diagram) +## How Skills Work (Flow Diagram) ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” @@ -127,7 +127,7 @@ antigravity-awesome-skills/ --- -## πŸ“ Skill File Anatomy (Visual) +## Skill File Anatomy (Visual) ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” @@ -171,7 +171,7 @@ antigravity-awesome-skills/ --- -## πŸš€ Installation (Visual Steps) +## Installation (Visual Steps) ### Step 1: Clone the Repository ``` @@ -222,7 +222,7 @@ antigravity-awesome-skills/ --- -## πŸŽ“ Example: Using a Skill (Step-by-Step) +## Example: Using a Skill (Step-by-Step) ### Scenario: You want to add Stripe payments to your app @@ -268,7 +268,7 @@ antigravity-awesome-skills/ --- -## πŸ” Finding Skills (Visual Guide) +## Finding Skills (Visual Guide) ### Method 1: Browse by Category ``` @@ -287,7 +287,7 @@ Open skills_index.json β†’ Search for keyword β†’ Find skill path --- -## πŸ› οΈ Creating Your First Skill (Visual Workflow) +## Creating Your First Skill (Visual Workflow) ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” @@ -322,7 +322,7 @@ Open skills_index.json β†’ Search for keyword β†’ Find skill path --- -## πŸ“Š Skill Complexity Levels +## Skill Complexity Levels ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” @@ -370,7 +370,7 @@ Your Contribution --- -## πŸ—ΊοΈ Learning Path (Visual Roadmap) +## Learning Path (Visual Roadmap) ``` START HERE @@ -459,7 +459,7 @@ START HERE --- -## πŸŽ‰ Success Stories (Visual Timeline) +## Success Stories (Visual Timeline) ``` Day 1: Install skills @@ -485,7 +485,7 @@ Month 1: Regular contributor --- -## πŸš€ Next Steps +## Next Steps 1. βœ… **Understand** the visual structure 2. βœ… **Install** skills in your AI tool