Skip to main content

Sharing docs with users without code access

You can share Swimm documents with users who don't have access to the repository. To do that, an admin needs to enable this feature for your repository, and then you can select specific documents to share.

Enable sharing with users without code access​

Note: you need to be an admin of your workspace in order to enable this feature.

Go to the Integrations & settings for the repo.

Then within the Sharing settings, toggle the option: "Doc sharing with members who don’t have code access."

Swimm sharing internally settings

After enabling this feature, you can select specific docs that will be shared.

Share a doc​

Note: to share a document, sharing must be enabled for the repository.

Go to the specific document you would like to share, and click on the Share button next to Edit doc.

Toggle on the Members without code access can view option:

Swimm sharing internally button

Select Copy private link to copy the url to your clipboard.

How to recognize a repository stored vs. Swimm-hosted doc​

Understanding where your Swimm docs are hosted can help you manage permissions and access more effectively. Below is a comparison between repository-stored docs and Swimm-hosted shared docs.

Doc StorageDescription
RepositoryHosted in your Git repository and requires Git permissions to access.
SwimmA version of the repository doc copied to Swimm's servers, accessible to anyone with a Swimm account.

Accessing Shared Docs​

You can find Shared docs in their own section, similar to how a repository is set up inside the web app's side menu. In the web app's side menu, the Shared docs section is organized for easy access towards the bottom of the list, to ensure you can quickly find the documentation you need.

Ask Swimm follow up questions

Swimm hosted doc URL​

https://app.swimm.io/workspaces/{workspaceId}/shared-docs/{docId}

Swimm hosted doc url

Repository hosted Doc URL​

https://app.swimm.io/workspaces/{workspaceId}/repos/{repoId}/branch/{branchId}/docs/{docId}

Repo hosted doc url

FAQ​

Will all of my documents be shared automatically?​

No. Users will have to explicitly share a document for it to be shared. Other documents are not shared, and only stored as Markdown files within your repository.

Who can access the shared documents?​

Only Swimm users in your workspace can view these documents.

Where are these documents stored?​

In addition to being stored on the repository, a published version is stored on Swimm's servers. This version is accessible only by people in your organization.

When are the documents updated?​

The shared version reflects the state on your default branch (e.g. - main). If you commit changes to the document, they will be reflected once you merge them to the default branch.

If no version of the document exists on the default branch (e.g. main), you can share a version on a side branch. You will be prompted for it when sharing a specific document.

Why can't I enable this feature?​

To enable this feature, you must be an admin of your workspace. If you are not an admin, please ask an admin to enable this feature.

You must also install Swimm's GitHub app or CLI tool for your CI/CD pipeline to enable this feature.

Why can't I share my document when sharing internally is enabled?​

Only documents that have been committed and pushed can be shared. All newly created documents are local to your web client until you push them remotely.

This document is automatically kept up to date using Swimm.