Skip to content

Commit d7ef0af

Browse files
Create github-integration.md
1 parent 9b7e366 commit d7ef0af

File tree

1 file changed

+199
-0
lines changed

1 file changed

+199
-0
lines changed

docs/github-integration.md

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
# 🔗 Github Integration & Changes
2+
3+
## Integrations update
4+
5+
## 📍 Where to Find Integrations
6+
7+
1. **Click your profile picture** in the top-right corner
8+
2. **Select "Settings"** from the dropdown menu
9+
3. **Click "Integrations"** in the left sidebar
10+
11+
## 🎯 Available Integrations
12+
13+
### 🐙 GitHub Integration
14+
**What it does:** Connects to your GitHub account to access your code repositories.
15+
16+
**Benefits:**
17+
- **Import Projects**: Bring your existing code into the AI builder
18+
- **Save Projects**: Export your AI-generated apps back to GitHub
19+
- **Real-time Updates**: Get notified when code changes in your repositories
20+
- **Collaboration**: Work with team members on shared repositories
21+
22+
**What you can do:**
23+
- Browse all your GitHub repositories
24+
- View and edit files directly
25+
- Create new repositories for your projects
26+
- Receive notifications about code changes
27+
28+
## 🔌 How to Connect a Service
29+
30+
### Step 1: Access Integrations
31+
- Go to **Settings → Integrations**
32+
33+
### Step 2: Find the Service
34+
- Locate the service you want to connect (e.g., GitHub)
35+
- You'll see a "Not connected" badge
36+
37+
### Step 3: Connect
38+
- Click the **"Connect"** button next to the service
39+
- You'll be redirected to the service's website (e.g., GitHub.com)
40+
- **Sign in** to your account if prompted
41+
- **Authorize** the AI App Builder to access your account
42+
- You'll be automatically redirected back
43+
44+
### Step 4: Confirmation
45+
- You'll see a success message
46+
- The service badge will change to "Connected"
47+
- You can now use the service's features
48+
49+
## ✅ Connection Status Indicators
50+
51+
### 🟢 Connected
52+
- **Green badge**: Service is working properly
53+
- **Shows connection date**: When you first connected
54+
- **Recent activity**: Displays latest interactions
55+
56+
### 🟡 Needs Attention
57+
- **Yellow badge**: Connection has issues
58+
- **Common causes**: Expired permissions, changed passwords
59+
- **Fix**: Disconnect and reconnect the service
60+
61+
### ⚪ Not Connected
62+
- **Gray badge**: Service is not connected
63+
- **Click "Connect"** to set up the integration
64+
65+
## 📊 Integration Health Monitoring
66+
67+
### GitHub Status Card
68+
When GitHub is connected, you'll see a special status card showing:
69+
70+
- **Connection Health**: Green = healthy, Yellow = needs attention
71+
- **Last Sync**: When data was last updated
72+
- **Recent Activity**: Latest repository events (pushes, pull requests, issues)
73+
- **Repository Count**: How many repos you have access to
74+
75+
### Activity Feed
76+
See real-time updates when:
77+
- Code is pushed to your repositories
78+
- Pull requests are created or merged
79+
- Issues are opened or closed
80+
- Team members make changes
81+
82+
## 🔄 Managing Connections
83+
84+
### Refreshing Status
85+
- Click the **"Refresh"** button to update connection status
86+
- Useful if you recently changed passwords or permissions
87+
88+
### Disconnecting Services
89+
1. Find the connected service
90+
2. Click **"Disconnect"**
91+
3. Confirm you want to remove the connection
92+
4. The service will be safely disconnected
93+
94+
**Note:** Disconnecting doesn't delete your data, just removes access.
95+
96+
### Reconnecting Services
97+
If a connection shows "Needs Attention":
98+
1. Click **"Disconnect"**
99+
2. Wait a moment
100+
3. Click **"Connect"** again
101+
4. Go through the authorization process
102+
103+
## 🛡️ Security & Privacy
104+
105+
### What We Access
106+
- **GitHub**: Repository lists, file contents, basic profile info
107+
- **Google Drive**: File lists, document contents (only what you authorize)
108+
- **Gmail**: Sending capabilities, basic profile info
109+
- **Calendar**: Event creation, calendar viewing
110+
111+
### What We Don't Access
112+
- ❌ Passwords or login credentials
113+
- ❌ Personal data unrelated to your projects
114+
- ❌ Data from other users or organizations
115+
- ❌ Financial or payment information
116+
117+
### Permissions
118+
- You control exactly what we can access
119+
- You can revoke permissions anytime
120+
- All connections use secure, industry-standard protocols
121+
122+
## 🚀 Platform Capabilities
123+
124+
### Always-On Features
125+
These features are automatically enabled:
126+
127+
- **⚡ Artifacts**: Create and run code in the sandbox
128+
- **📋 Fragment Templates**: Access to pre-built project templates
129+
- **☁️ E2B Sandbox**: Secure cloud environment for running code
130+
131+
### API Access
132+
- **Personal Access Tokens**: Generate tokens for advanced automation
133+
- **API Integration**: Connect with external tools and services
134+
- **Webhook Support**: Receive real-time updates from connected services
135+
136+
## ❓ Troubleshooting
137+
138+
### Connection Failed
139+
**Problem**: "Failed to connect service" error
140+
**Solutions:**
141+
- Check your internet connection
142+
- Try connecting again in a few minutes
143+
- Make sure you're logged into the service (GitHub, Google, etc.)
144+
- Check if the service is experiencing outages
145+
146+
### Permission Denied
147+
**Problem**: "Access denied" or "Permission error"
148+
**Solutions:**
149+
- Make sure you clicked "Authorize" during connection
150+
- Check if your account has the necessary permissions
151+
- For GitHub: Ensure you have access to repositories
152+
- For Google: Check if your Google account is active
153+
154+
### Connection Shows "Needs Attention"
155+
**Problem**: Previously working connection is now yellow
156+
**Solutions:**
157+
- Disconnect and reconnect the service
158+
- Check if you changed your password recently
159+
- Verify the service didn't revoke permissions
160+
161+
### No Recent Activity
162+
**Problem**: GitHub shows connected but no recent activity
163+
**Solutions:**
164+
- Make some changes to your repositories (push code, create issues)
165+
- Check if webhooks are properly configured
166+
- Use the "Refresh" button to update status
167+
168+
## 💡 Tips for Best Experience
169+
170+
### Getting Started
171+
1. **Start with GitHub** - Most useful for code projects
172+
2. **Test with a simple repository** - Make sure everything works
173+
3. **Check activity feed** - Verify real-time updates are working
174+
175+
### For Teams
176+
1. **Connect shared repositories** - Access team projects
177+
2. **Use Google Drive** - Share files and documents
178+
3. **Set up Gmail notifications** - Keep everyone updated
179+
180+
### Security Best Practices
181+
1. **Review permissions regularly** - Check what services can access
182+
2. **Disconnect unused services** - Remove integrations you don't need
183+
3. **Use strong passwords** - Secure your connected accounts
184+
185+
## 🆘 Need Help?
186+
187+
### Quick Solutions
188+
- **Refresh the page** - Sometimes fixes temporary issues
189+
- **Try disconnecting and reconnecting** - Resets the connection
190+
- **Check service status pages** - GitHub, Google might have outages
191+
192+
### Still Having Issues?
193+
- Contact support with specific error messages
194+
- Include which service you're trying to connect
195+
- Mention if it worked before or is a new connection
196+
197+
---
198+
199+
*Last updated: [July 6th 2025] - Features and interfaces may change as we continue improving the platform.*

0 commit comments

Comments
 (0)