Swimm Docs Plugin

Documentation Platform Built for Engineers.
Never let onboarding, outdated documents, or context switching slow you down.
Swimm keeps development smooth with documentation that is always up to date and synced with your code.

• Integrate Documentation in your IDE
• Use Swimm's integration with VS Code to access docs right in your IDE next to your code.
• Finding and reading docs is easy - Swimm Docs are all in Markdown.

Features

1. Read documentation directly in your IDE

With the Swimm Docs plugin, you can review documentation next to the code you are working on.

2. Find and access Swimm Docs in your workplace

Under the Swimm plugin panel, review all docs under "Repo Docs" and "Current File."

Requirements

To have the docs available in your local environment, be sure you create them with the Swimm Web App web app first. We are currently working on allowing you to create docs directly from your IDE. Stay tuned!

ℹ️ Note:

Currently, the plugin doesn't support child level repositories, or if you are working with Git submodules. You will be required to have a VS Code workspace on the same level.

💡Tip:

Add a .vscode/extensions.json file to your repo to access Swimm Docs and notify your team about the Swimm plugin. More details on workspace recommended extensionshere.

View change log.

Happy Swimming!