To get started with Swimm, we suggest running through this Quick Start Guide we've created.
Get Started With Swimm
Bring documentation to your team to make knowledge sharing faster, easier, and coupled to code.
Once your workspace is set up, connect your GitHub repository.
Step 1: Click "Connect a Repo" from the sidebar.
Step 2: Connect your repository. Select from either "All repositories" or "Public repositories only" and then click "Allow GitHub Access."
Step 3: Sig into GitHub.
Step 4: Select your repository.
If you're asking yourself, "Where do I start?" here are a few quick tips.
On the documentation front, starting small is absolutely fine!
➡️ Select a Code Snippet and write notes to walk another developer through the code
➡️ Review Draft Documentation from your Pull Requests that Swimm creates automatically for you
➡️ Use on of Swimm's Templates to help you get a documentation jump start
To Add a Swimm Snippet
✅ Click on / and choose "snippet" from the dropdown
✅ Highlight the code using your mouse
✅ Click enter to add the code snippet
✅ Click Esc to go back to the editor
To Save and Committ:
✅ Click on the "Create Pull Request" button in the top right corner
✅ Create a new branch to start a Pull Request or push to an existing branch
All docs will be saved under the .swm folder once the docs are committed to the repo.
✅ Install and enable the Swimm plugin for VS Code or IntelliJ
✅ If you are using VS Code, once you click on the Swimm icon, the IDE will open a new tab containing your Swimm Doc
✅ If you are using IntelliJ, click on the Swimm buoy, and the IDE will open a new tab containing your Swimm Doc
Swimm's GitHub App will verify that all your documents are updated on every Pull Request
✅ Click on Integrations in the top right corner
✅ Click on Install GitHub App
Create documentation to ramp up onboarding new developers and engineers with Swimm Playlists
🌊 Complex Code
Create documentation for complex code and nonstandard processes that is confusing and requires more information
🌊 Knowledge Silos
Create documentation to eliminate legacy code and promote inclusive teams & knowledge sharing