Skip to main content

Connecting Repositories to Swimm

Once you've created your first workspace, you'll need to add your repositories.

Step 1: From the main workspace menu, on the left side, click Connect a Repo from the sidebar.

Set up your repo

Step 2: Connect your repository. Select a public or private repo and click on Allow GitHub Access.

Read more about our security and privacy overview Security, Privacy, & GitHub Swimm Developer Community.

Set up your repo

Step 3: Sign into GitHub

Sign into GitHub

Step 4: Search and then select the repository you plan to document. Once you’ve selected your repo, you can get started creating or reviewing documentation.

If you don't see the repository you wish to add, Swimm doesn't have the correct permissions required and you’ll need to click the Manage Scope button at the bottom of the dialog box.

Don't see your repo

If you still cannot locate your repo, please reach out to us on our Community Slack Channel.

How to Change the Order of Repositories

You can change the order of repositories displayed on the left-side navigation. Hover over any repository and drag the repository using the new 8-pin icon.

Note that changing the order of your repositories only affects your Swimm account and not other members' accounts.