Documentation with Swimm is always synced with your code.
That makes Swimm docs reliable, streamlined & easy to find
How Swimm documentation is different?
Swimm
Other tools
Rich editor & slash commands
✅
✅
Find documents in the platform
✅
✅
Maintain up-to-date documentation
✅
❌
Find docs in the IDE
✅
❌
CI integrations
✅
❌
Features
1. Read documentation directly in your IDE
Look for the wave icon. Any docs related to a particular section of code will appear just above it.
Quick start
Log in (or create your free account)
Create some docs on Swimm's Web Platform
Find your docs in the IDE
FAQ
Where and how is my data stored and saved?
None of your actual code or content is stored on Swimm's server.
Swimm never makes a copy of your code.
The GitHub token is not stored at any time on Swimm's servers.
Swimm is SOC 2 compliant.
What is the value of using Swimm?
Swimm allows you to create code-coupled documentation by adding live snippets from your code.
Documentation becomes easily manageable thanks to Swimm's Auto-sync algorithm that helps users keep these snippets and your documentation always up to date.
We are currently working on allowing you to create docs directly from the plugin. Stay tuned!
💡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 extensions here.
