mirror of
https://github.com/supabase/agent-skills.git
synced 2026-03-27 10:09:26 +08:00
starting point for each product
This commit is contained in:
147
skills/using-supabase/PRODUCT_TEMPLATE.md
Normal file
147
skills/using-supabase/PRODUCT_TEMPLATE.md
Normal file
@@ -0,0 +1,147 @@
|
||||
# Product Team Contribution Guide
|
||||
|
||||
This document provides step-by-step instructions for adding your product's content to the Supabase Agent Skills.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Setup Your Branch
|
||||
|
||||
```bash
|
||||
git checkout feature/supabase-skill
|
||||
git pull origin feature/supabase-skill
|
||||
git checkout -b feature/supabase-skill-{your-product}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Create Your Hub File
|
||||
|
||||
Create a hub file at `skills/using-supabase/references/supabase-{your-product}.md`:
|
||||
|
||||
```markdown
|
||||
# Supabase {Your Product} Guide
|
||||
|
||||
Brief description of what this product does and when to use it.
|
||||
|
||||
## Quick Start
|
||||
|
||||
Basic setup/usage example.
|
||||
|
||||
## Core Concepts
|
||||
|
||||
Key concepts developers need to understand.
|
||||
|
||||
## Common Patterns
|
||||
|
||||
Link to sub-resources for detailed patterns:
|
||||
- [Pattern 1](./supabase-{your-product}/pattern-1.md)
|
||||
- [Pattern 2](./supabase-{your-product}/pattern-2.md)
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
What to avoid and why.
|
||||
|
||||
## Related Resources
|
||||
|
||||
Links to other Supabase products that integrate with this one.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Create Sub-Resources (Optional)
|
||||
|
||||
For detailed patterns, create a subdirectory:
|
||||
|
||||
```
|
||||
skills/using-supabase/references/
|
||||
├── supabase-{your-product}.md # Hub file
|
||||
└── supabase-{your-product}/ # Sub-resources
|
||||
├── pattern-1.md
|
||||
├── pattern-2.md
|
||||
└── common-mistakes.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Content Guidelines
|
||||
|
||||
**DO:**
|
||||
- Use concrete code examples (TypeScript/JavaScript)
|
||||
- Show incorrect patterns with explanations
|
||||
- Include error messages developers might see
|
||||
- Link to related Supabase products
|
||||
- Keep files focused (one concept per file)
|
||||
|
||||
**DON'T:**
|
||||
- Duplicate official documentation verbatim
|
||||
- Include overly long examples (keep under 50 lines)
|
||||
- Assume prior Supabase knowledge
|
||||
- Include time-sensitive content (versions, dates)
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Reference File Format
|
||||
|
||||
Each reference file should follow this structure:
|
||||
|
||||
```markdown
|
||||
# Title
|
||||
|
||||
One-paragraph description of this pattern/concept.
|
||||
|
||||
## When to Use
|
||||
|
||||
Describe the use case.
|
||||
|
||||
## Example
|
||||
|
||||
**Setup:**
|
||||
\`\`\`typescript
|
||||
// Setup code
|
||||
\`\`\`
|
||||
|
||||
**Usage:**
|
||||
\`\`\`typescript
|
||||
// Usage example
|
||||
\`\`\`
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
**Incorrect:**
|
||||
\`\`\`typescript
|
||||
// What not to do
|
||||
\`\`\`
|
||||
|
||||
**Correct:**
|
||||
\`\`\`typescript
|
||||
// What to do instead
|
||||
\`\`\`
|
||||
|
||||
## Related
|
||||
|
||||
- [Related Resource 1](./path-to-resource.md)
|
||||
- [Official Docs](https://supabase.com/docs/...)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Open Pull Request
|
||||
|
||||
```bash
|
||||
git add skills/using-supabase/references/
|
||||
git commit -m "feat(skill): add {your-product} references"
|
||||
git push origin feature/supabase-skill-{your-product}
|
||||
```
|
||||
|
||||
Open PR targeting `feature/supabase-skill` with:
|
||||
- Summary of content added
|
||||
- List of files created
|
||||
- Any cross-references to other products
|
||||
|
||||
---
|
||||
|
||||
## Step 7: Review Process
|
||||
|
||||
1. Product team member reviews for technical accuracy
|
||||
2. AI team reviews for skill format compliance
|
||||
3. Merge to `feature/supabase-skill`
|
||||
9
skills/using-supabase/metadata.json
Normal file
9
skills/using-supabase/metadata.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"organization": "Supabase",
|
||||
"date": "January 2026",
|
||||
"abstract": "Comprehensive Supabase development guide covering Auth, Storage, Edge Functions, Realtime, CLI, supabase-js SDK, and MCP integration.",
|
||||
"references": [
|
||||
"https://supabase.com/docs"
|
||||
]
|
||||
}
|
||||
0
skills/using-supabase/references/.gitkeep
Normal file
0
skills/using-supabase/references/.gitkeep
Normal file
Reference in New Issue
Block a user