Finding Documentation with Swimm's Visual Studio Plugin

On this page

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

Using the Search Feature​

The Swimm Visual Studio plugin includes a powerful search feature that helps you find relevant documentation within your codebase. You can search for documentation by:

• Document title
• Document content
• Code snippets
• File paths
• And more

To use the search feature, simply click on the search icon in the Swimm panel and enter your search query.

Browsing Repository Documentation​

The REPO DOCS panel shows all the Swimm documentation available in your repository. You can browse through the documentation by:

• Clicking on a document to open it
• Using the filter options to narrow down the list
• Sorting documents by various criteria

Navigating Between Code and Documentation​

One of the key features of the Swimm Visual Studio plugin is the ability to navigate seamlessly between your code and its documentation:

1. Code to Docs: When viewing code, you can see which parts of the code are documented and quickly jump to the relevant documentation.
2. Docs to Code: When reading documentation, you can click on code snippets to navigate directly to that code in your project.

This bidirectional navigation makes it easy to understand code through its documentation and to find the documentation for specific code.

---

This document is automatically kept up to date using Swimm.

• Using the Search Feature
• Browsing Repository Documentation
• Navigating Between Code and Documentation

---

Read this article on Swimm's official docsite