Skip to content

troubleshooting

Jump to bottom
Mile Shi edited this page May 26, 2025 · 1 revision

Troubleshooting

This guide helps you resolve common issues when using the Intelligent IDE VS Code extension.

Common Issues

Installation and Setup Issues

Extension Not Loading

Symptoms: Extension doesn't appear in VS Code or fails to activate

Solutions:

  1. Verify VS Code Version

    code --version
# Ensure version 1.60.0 or higher

  2. Check Extension Installation

    • Open Extensions panel (Ctrl+Shift+X)
    • Search for "Intelligent IDE"
    • Ensure it's installed and enabled

  3. Restart VS Code

    • Close all VS Code windows
    • Reopen VS Code
    • Check if extension loads

  4. Clear Extension Cache

    # macOS
rm -rf ~/.vscode/extensions/cache

# Windows
rmdir /s "%USERPROFILE%\.vscode\extensions\cache"

# Linux
rm -rf ~/.vscode/extensions/cache

Connection Issues

Symptoms: Cannot connect to backend server

Solutions:

  1. Check Network Connection

    ping api.intelligent-ide.com
curl -I https://api.intelligent-ide.com/health

  2. Verify Firewall Settings

    • Allow VS Code through firewall
    • Check corporate proxy settings
    • Whitelist required domains

  3. Update Server Configuration

    {
  "intelligentIDE.serverUrl": "https://api.intelligent-ide.com",
  "intelligentIDE.timeout": 30000,
  "intelligentIDE.retryAttempts": 3
}

Authentication Problems

Login Failures

Symptoms: Cannot log in to the system

Solutions:

  1. Verify Credentials

    • Double-check email and password
    • Ensure caps lock is off
    • Try password reset if needed

  2. Check Account Status

    • Verify email confirmation
    • Check if account is suspended
    • Contact administrator if needed

  3. Clear Authentication Cache

    # Clear stored tokens
code --list-extensions | grep intelligent-ide
# Uninstall and reinstall extension if needed

Token Expiration

Symptoms: Frequent re-login requests

Solutions:

  1. Check Token Settings

    {
  "intelligentIDE.auth.autoRefresh": true,
  "intelligentIDE.auth.tokenLifetime": "24h"
}

  2. Manual Token Refresh

    • Use Command Palette: Intelligent IDE: Refresh Token
    • Or logout and login again

Course and File Management

Cannot Access Course

Symptoms: Course not visible or accessible

Solutions:

  1. Verify Enrollment

    • Check if properly enrolled in course
    • Verify course status (active/inactive)
    • Contact instructor if needed

  2. Refresh Course List

    • Use Command Palette: Intelligent IDE: Refresh Courses
    • Restart extension if needed

  3. Check Permissions

    • Verify role (student/teacher/TA)
    • Check course access permissions
    • Ensure course hasn't ended

File Sync Issues

Symptoms: Files not syncing between local and server

Solutions:

  1. Manual Sync

    // Use sync command
Intelligent IDE: Sync Files

  2. Check File Size Limits

    • Ensure files are under size limit (100MB)
    • Compress large files if needed
    • Split large projects into smaller parts

  3. Verify Network Stability

    • Check internet connection
    • Try sync during off-peak hours
    • Use wired connection if possible

Collaboration Issues

Cannot Join Collaboration Session

Symptoms: Error when trying to join collaborative editing

Solutions:

  1. Verify Session ID

    • Check session ID is correct
    • Ensure session is still active
    • Confirm you have permission to join

  2. Check WebSocket Connection

    # Test WebSocket connectivity
wscat -c wss://api.intelligent-ide.com/ws

  3. Firewall Configuration

    • Allow WebSocket connections
    • Check port 443 and 80 access
    • Configure proxy for WebSocket

Sync Delays in Collaboration

Symptoms: Changes appear slowly for other users

Solutions:

  1. Optimize Network

    • Use stable internet connection
    • Close bandwidth-intensive applications
    • Consider upgrading internet plan

  2. Reduce Session Size

    • Limit number of participants
    • Work on smaller files
    • Split large collaborative tasks

Notebook and Code Execution

Code Execution Failures

Symptoms: Code cells don't execute or produce errors

Solutions:

  1. Check Python Environment

    # Verify Python installation
python --version
pip list

# Install required packages
pip install -r requirements.txt

  2. Kernel Issues

    • Restart notebook kernel
    • Clear output and restart
    • Check kernel logs for errors

  3. Memory Issues

    # Monitor memory usage
import psutil
print(f"Memory usage: {psutil.virtual_memory().percent}%")

Package Installation Problems

Symptoms: Cannot install Python packages

Solutions:

  1. Update pip

    python -m pip install --upgrade pip

  2. Use Alternative Index

    pip install --index-url https://pypi.org/simple/ package_name

  3. Virtual Environment

    python -m venv venv
source venv/bin/activate  # macOS/Linux
venv\Scripts\activate     # Windows
pip install package_name

Performance Issues

Slow Extension Performance

Symptoms: Extension responds slowly or freezes

Solutions:

  1. Check System Resources

    # Monitor CPU and memory
top -p $(pgrep code)

  2. Optimize VS Code Settings

    {
  "files.watcherExclude": {
    "**/node_modules/**": true,
    "**/.git/**": true,
    "**/storage/**": true
  },
  "files.autoSave": "onFocusChange"
}

  3. Disable Unnecessary Extensions

    • Temporarily disable other extensions
    • Identify conflicting extensions
    • Keep only essential extensions active

Large File Handling

Symptoms: Performance issues with large notebooks or datasets

Solutions:

  1. File Size Optimization

    • Split large notebooks into smaller ones
    • Use data sampling for development
    • Clear output cells before saving

  2. Streaming and Pagination

    # Process large datasets in chunks
import pandas as pd

chunk_size = 1000
for chunk in pd.read_csv('large_file.csv', chunksize=chunk_size):
    process_chunk(chunk)

Error Messages

Common Error Codes

Error 401: Unauthorized

Cause: Authentication token expired or invalid
Solution: 
1. Log out and log back in
2. Clear authentication cache
3. Check account status

Error 403: Forbidden

Cause: Insufficient permissions
Solution:
1. Verify course enrollment
2. Check user role permissions
3. Contact course administrator

Error 404: Not Found

Cause: Resource doesn't exist or was deleted
Solution:
1. Check resource URL/ID
2. Verify resource still exists
3. Refresh resource list

Error 500: Internal Server Error

Cause: Server-side issue
Solution:
1. Wait and try again later
2. Check server status page
3. Contact technical support

Debug Mode

Enable Debug Logging

{
  "intelligentIDE.debug": true,
  "intelligentIDE.logLevel": "debug"
}

View Debug Logs

  1. Open Command Palette (Ctrl+Shift+P)
  2. Run: Developer: Show Logs
  3. Select "Extension Host"
  4. Look for Intelligent IDE entries

Collect Debug Information

# System information
code --version
node --version
npm --version

# Extension information
code --list-extensions | grep intelligent

Getting Help

Self-Help Resources

  1. Documentation: Check this wiki thoroughly
  2. FAQ Section: Review frequently asked questions
  3. Video Tutorials: Watch demonstration videos
  4. Community Forums: Search existing discussions

Contact Support

Technical Support

Course-Specific Issues

  • Contact Instructor: For course enrollment and content issues
  • Teaching Assistants: For assignment and grading questions
  • Academic Support: For learning and usage guidance

Bug Reports

  1. Check Known Issues: Review existing bug reports
  2. Reproduce Issue: Document exact steps
  3. Collect Information: Logs, screenshots, system details
  4. Submit Report: Use bug report template

Emergency Procedures

Assignment Deadline Issues

  1. Document the Problem: Screenshot error messages
  2. Contact Instructor Immediately: Don't wait
  3. Save Work Locally: Backup your progress
  4. Submit via Alternative Method: Email if necessary

Data Loss Prevention

  1. Regular Backups: Save work frequently
  2. Version Control: Use git for important projects
  3. Export Data: Download copies of important work
  4. Multiple Copies: Keep work in multiple locations

Prevention Tips

Best Practices

  1. Keep Extension Updated: Enable automatic updates
  2. Regular Maintenance: Clear cache periodically
  3. Stable Environment: Use supported VS Code versions
  4. Network Stability: Use reliable internet connection
  5. Resource Management: Monitor system resources

Proactive Monitoring

{
  "intelligentIDE.monitoring": {
    "performance": true,
    "errors": true,
    "usage": true
  }
}

System Health Checks

  • Weekly: Check for extension updates
  • Monthly: Clear cache and restart VS Code
  • Semester: Review and optimize settings
  • Important commands and tools

Team Members

List the team members along with their roles and responsibilities. This can help everyone know who to reach out to for specific questions or tasks.

Name Role Contact Information
Alice Smith Project Manager team-lead@intelligent-ide.project
Bob Johnson Lead Developer developer@intelligent-ide.project
Carol White UX/UI Designer designer@intelligent-ide.project

Documentation

Link to important documentation resources, such as:

Resources

Provide links to any additional resources that may be helpful for the team, such as:

  • Design assets
  • Code style guides
  • Project management tools

FAQs

Include a section for frequently asked questions to help new members quickly find answers to common queries.

Contact

For any questions or concerns, please reach out to the project manager or your team lead.

Feel free to edit and expand this wiki as the project evolves. Your contributions are valuable!


### Tips for Maintaining the Wiki:
- **Regular Updates**: Keep the wiki updated with the latest information and changes in the project.
- **Encourage Contributions**: Invite team members to add their insights and resources to the wiki.
- **Organize Content**: Use clear headings and subheadings to make navigation easy.
- **Use Links**: Link to relevant documents, repositories, and external resources for easy access.

This structure should provide a solid foundation for your team project wiki. Adjust the content as necessary to fit your team's specific needs!

🏠 Home

📖 User Guide

🛠️ Developer Guide

⭐ Features

📚 Tutorials

Clone this wiki locally