Ricardo Lopez

You can create a document from a pull request. This is especially useful when a pull request tells a coherent "story" - for example, when it shows the addition of a new feature. Steps to create a d...

This feature utilizes the power of AI, Swimm's code analysis capabilities and our expertise in creating effective developer documentation. Section suggestions​ Provide a title for your document, ...

With Swimm, you can describe flows spanning across multiple repositories, by including snippets, tokens and paths from multiple repositories, in the Web app and IDE. Web app​ Snippets​ To insert a ...

Click Create on the repo page and see the options to get started writing documentation: Here are some of the options you’ll see there: infoIf you create your Swimm doc from your workspace home,...

This page describes tips and tricks for using Swimm's editor. Selecting tokens​ When adding Smart Tokens, Swimm suggests tokens from across the repositories in your workspace. If you don't find th...

Folders are one of the ways to organize and find documents in Swimm. Folders are a way to group related documents. Every doc, playlist and folder in the repository can have a parent folder. Using ...

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 the commands m...

Swimm 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 Commit # butt...

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 select one ...

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...