Create docs that are coupled with your code and integrated into your workflow.
Easy to create
Easy to find
Always Up-to-date
How it Works
Easy to Create: Snippet Studio
Easily create walkthroughs, tutorials and smart documents directly from your codebase. The Snippet Studio enables you to highlight specific code areas and incorporate comments to explain code flows and logic. Line those up into Playlists that cover a certain issue or topic.
Easy to Find: Code Documentation Coverage
Swimm's Tree View enables to quickly search which files and folders have corresponding Swimm tutorials. Find which important files lack documentation, or find tutorials you need just in time.
Up-to-date: Auto Sync
Codebases change every day, your tutorials and documentation should too. The Auto-Sync algorithm automatically suggests changes to your documentation as the code evolves, verifying tutorials stay up to date.
Swimm with your Team
Security is Core to what we do at Swimm
No code or tutorials are ever sent to Swimm's servers. Swimm does not require access to the original repository. All content you create using Swimm is stored as .swm files on your repository. Only users with access to your repository can access this content.
Get the FAQsSwimm Specs
Agnostic
We're stack agnostic and speak all languages
All operating systems
Download beta for Mac, Windows, Linux
Roles
Admins can sync repo’s and invite new contributors to collaborate and create content
Secure
No information regarding your code is ever sent to Swimm's servers.
CLI
Swimm directly in your CLI for advanced interactive tutorials.
CI and Local Git Hooks
Swimm notifications for when content is outdated.
Getting Started with Swimm
Swimm acts as an add-on to any codebase and is accessible locally to all its contributors. Add Swimm to your repo to start creating tutorials and documentation.