Skip to content

3. Troubleshooting

Heesu Suh edited this page Jan 29, 2025 · 3 revisions

Troubleshooting ⚠️

This guide helps you resolve common issues with Smart Composer.

Common Issues and Solutions

Plugin Not Loading

  1. Outdated Obsidian Installer

    • Update Obsidian via Settings > General > Check for updates
    • If issues persist, download latest installer from Obsidian's download page
    • Close Obsidian completely and run new installer
  2. Plugin Initialization Failed

    • Disable and re-enable the plugin
    • Restart Obsidian
    • Check console for error messages

API Key Issues

  1. Invalid API Key

    • Verify key is correctly copied
    • Check for extra spaces
    • Generate new key if needed
  2. API Rate Limits

    • Wait a few minutes before retrying
    • Consider upgrading API tier
  3. Insufficient API Credits

    • Check remaining balance in API provider dashboard
    • Add credits if balance is low

Vault Search Problems

  1. Search Not Working
    • Rebuild vault index: Smart Composer: Rebuild entire vault index

Context Issues

  1. Website Context Failed
    • Check internet connection
    • Verify website is accessible

Plugin Conflicts

Some plugins may interfere with Smart Composer's functionality due to overlapping features or conflicting code. Here are known issues and their solutions:

  1. Known Plugin Conflicts

    • Canvas Mindmap Plugin (issue #171)
      • Causes "endsWith is not a function" error when using Apply Edit
      • Temporary solution: Disable Canvas Mindmap when using Smart Composer
  2. General Tips

    • Check Developer Tools for error messages
    • Try disabling suspected plugins temporarily
    • Keep all plugins updated to latest versions
    • If issues persist, report them on GitHub

General Troubleshooting Tips

  1. Check Developer Tools
    • Open Developer Tools using:
      • Mac: Cmd + Option + I
      • Windows/Linux: Ctrl + Shift + I
    • Or via menu: View > Toggle Developer Tools
    • Look for error messages in the Console tab

Getting Help

If you're still experiencing issues:

  1. Check our GitHub Issues
  2. Join GitHub Discussions
  3. Submit a bug report
  4. Check for plugin updates

Clone this wiki locally