Skip to main content

Q&A and Troubleshooting for Swimm's Visual Studio Plugin

Ricardo Lopez
On this page

Note: This is the Preview version of the Visual Studio plugin.

Frequently Asked Questions​

General Questions​

Q: Is the Visual Studio plugin free to use? A: Yes, the Swimm Visual Studio plugin is free to use. You will need a Swimm account, which also has free tiers available.

Q: Which versions of Visual Studio are supported? A: The plugin supports Visual Studio 2019 and later versions.

Q: Can I use the plugin with multiple repositories? A: Yes, you can use the plugin with multiple repositories, but you'll need to switch between them in the Swimm panel.

Feature Questions​

Q: How does Auto-sync work in the Visual Studio plugin? A: Auto-sync automatically detects changes to code referenced in your documentation and updates the documentation accordingly. You can see the status of each document in the Swimm panel.

Q: Can I create documentation for code that isn't in my current branch? A: Yes, you can use the Branch2doc feature to create documentation for specific branches.

Q: How do I search for documentation? A: You can use the search feature in the Swimm panel to find documentation by title, content, code snippets, and more.

Troubleshooting​

Installation Issues​

Problem: The plugin doesn't appear in Visual Studio after installation. Solution: Try the following steps:

  1. Restart Visual Studio
  2. Check if the plugin is enabled in the Extensions menu
  3. Reinstall the plugin if necessary

Authentication Issues​

Problem: I can't log in to my Swimm account. Solution: Try the following steps:

  1. Check your internet connection
  2. Clear your browser cookies and cache
  3. Ensure you're using the correct credentials
  4. Contact Swimm support if the issue persists

Usage Issues​

Problem: I can't see my repository's documentation. Solution: Try the following steps:

  1. Make sure your repository is properly initialized with Swimm
  2. Check if you have the correct permissions to access the documentation
  3. Refresh the Swimm panel

Problem: Auto-sync isn't working correctly. Solution: Try the following steps:

  1. Check if the affected code snippets are properly formatted in the documentation
  2. Ensure your repository is properly connected to Swimm
  3. Try manually updating the documentation

Getting Additional Help​

If you're experiencing issues not covered in this guide, you can get help through the following channels:

This document is automatically kept up to date using Swimm.

Read this article on Swimm's official docsite

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk