Ricardo Lopez

On this page Swimm’s slash editor commands are a great way to quickly create and edit content in your documents. Swimm commands menu​ To use these commands, type / at any line, and you will see th...

On this page Overview​ Swimm's Rules is a feature that links your codebase to relevant documentation using Regex rules. You can customize these rules based on your unique needs, enhancing your unde...

On this page You can create diagrams and charts in your Swimm doc using Mermaid syntax in the editor. Mermaid + Swimm = up-to-date diagrams 🤯​ To get started, type /Diagram to start from scratch or...

On this pageSwimm web app​ Swimm docs are auto-saved to your local browser as you go. Docs you create and modify will not be accessible by others until you commit to the repository. Click on the C...

As you edit your docs, you will likely mention some references to parts of the code and Swimm offers auto-detection and suggestions for these code references. Example: In an example document, “How...

Use cases for Swimm include: 🌊 Open bottlenecks in development Clarify highly complex code that slows down development, by explaining reasons behind development decisions, walking through elabo...

Continuous Documentation was pioneered by Swimm to meet the challenges of modern software development teams who have been struggling with little or mostly outdated documentation. Continuous Documen...

On this pageDaC (Documentation as Code) is an approach of treating documentation like code so that documentation and code are created and maintained together. Docs as Code principles include the fo...

On this page Swimm is private and secureSwimm is SOC 2 and ISO27001 compliant. Swimm does not modify any of your code and none of your actual code or content is stored on Swimm’s servers, including...

On this pageThe specific instructions will depend on your Git Provider. Git ProviderStatusInstallation GuideLocal mode availableVerify Swimm docs are up-to-date with the codebaseAre documents or co...