Skip to main content

Β· One min read
Swimm

We're pleased to announce the availability of Swimm 0.10.0❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

Improvements:​

  • Smart Tokens - Additional information about the token is displayed when clicking on the Swimm token rather than hovering over it. Β 
  • Statistics Tab - The statistic usage dashboard has been updated. You can now see the total number of docs in your workspace, recently created docs, your workspace's top contributors, and the most read docs, including how many docs were read and where they were consumed.
  • UI Improvements - UI improvements including adding icons to the "Paste HTML" & "Paste Markdown" options, the hamburger button popup, and the discard draft icon.

Bug Fixes​

  • Fixed: the ability to paste an image into the editor.
  • Fixed: navigating steps when editing Playlists.
  • Fixed: deleting docs from the home page.
  • Fixed: clicking edit on doc requests.
  • Fixed: Editor topbar path title of documents.
  • Fixed: other minor bugs.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· One min read
Swimm

We're pleased to announce the availability of Swimm 0.9.9❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

Improvements:​

  • Insights for Admins - Admins can now more easily review their team’s coverage status and insights for the repo. The recommended files will help you to increase coverage by directing the right people to the right files.
  • Mermaid Editing - You can use Mermaid syntax by either just pasting the Mermaid syntax in the Editor or using the / command.
  • Performance Enhancement for Creating New Docs - Opening a new blank doc is now quicker and easier.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 3 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.8❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Content Suggestions - To ease the writing process in new blank docs, you can now get suggestions for picking a document title and structuring your docs. When you start to write the title, a dropdown appears with title and document type suggestions. Once a title is selected, the editor sidebar suggests relevant content block templates you can add to the doc.
  • GitHub App Settings - There is a new GitHub App Settings option to skip automatic Auto-sync approval on draft PRs.
  • Import Data From Other Apps - Swimm now supports importing data from other apps such as Notion & Confluence so you can centralize all of your data in one place. To start importing, simply click the New icon on the repo page, and select the desired import option.
  • Import Multiple Markdown Files - You can now import multiple Markdown files at once! Simply click the New icon on the repo page, and either manually upload from your computer or scan your repository to detect all existing Markdown files to import to Swimm.
  • Auto-Join Swimm Workspaces - If you are an Admin of your team's workspace, you can now enable auto-workspace. Join with your company's email domain rather than having new members request to join. Note, this is currently only available to members signing up through Google. You can configure Auto-Join under the Invites component on the home page.

Improvements:​

  • Creating Docs in Playlists - You can create new documentation for your Playlists inside an existing Playlist. Rather than having to create documentation first and then add them to your Playlist, you can now create docs from within the Playlists without needing to switch contexts. When you add a step to your Playlist, select Blank doc or another option to start building your dream Playlist.
  • PR Comments in GitHub App - When a new PR comment is added by Swimm related to outdated or Auto-synced content, previous Swimm comments in the PR are automatically hidden.
  • Create Doc From PR - When inside the default branch of a repository, the Merged Pull Requests section is no longer displayed.
  • Cloud Docs - Added support for Mermaid diagramming and charting.
  • Doc Tags - In a documentation list, we now show the Manage Tags menu when clicking the tag icon instead of hovering over it.

Bug Fixes​

  • Cloud Docs - When sharing a draft and navigating to the shared link and clicking Edit an Unavailable Document page is no longer displayed.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 3 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.7❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Mermaid Diagrams in Swimm - You can now add diagrams and charts to your documentation in Swimm, using mermaid syntax in the editor. Type /mermaid to start editing your mermaid diagram, or use templates from Mermaid Live Editor.

  • Admin Rules- Admins in Swimm can now automate workflows using Swimm's GitHub app. Admins can set conditions and actions to promote documentation creation and consumption.

  • Continuous Publish - Admins can now allow publishing docs from a repo to the Cloud, so that even when users don't have access to the repo, they will still be able to view those docs. Published docs are kept in sync with Swimm's GitHub App.

  • Multi-repo Docs - Multi-repo docs are docs that contain one or more snippets from more than one repository. With Swimm, you can now create docs with code snippets across multiple repositories. Here's how: when opening the Snippet Studio, select snippets from any workspace repository. Note that selecting Smart Tokens and Smart Paths from other repositories is not currently supported. Snippets in a Multi-repo doc from other repositories are always Auto-synced from the default branch. When there are outdated or Auto-synced snippets in a Multi-repo doc, they can be resolved directly from the Swimm App (not from Swimm's GitHub App).

  • Global Search - You can now search from anywhere across code-coupled docs, cloud docs, and Playlists in your workspace. To search, use ⌘+K (MacOS) or CTRL+K (Windows/Linux) or the search icon at the top right corner. For code-coupled content, Swimm will perform a global search only on the default branch and on committed docs/Playlists.

Improvements:​

  • New Section for Docs and Playlist Versions - Instead of viewing multiple files for each version of a doc, you can now see the most relevant version of the Doc or Playlist. Docs with versions in-progress will have a small stack icon near their name. When you click the icon, you’ll see all versions of your Doc and Playlist (drafts, pending, and committed).
  • Multiple File Import - Swimm now supports the ability to import multiple Markdown files. You can choose whether you want to import files from your computer, or Swimm can scan your repo and detect all of your Markdown files to create Swimm docs.

Bug Fixes:​

  • Fixed: when creating a doc from a PR and discarding the generated draft, the draft is now removed.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 2 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.6❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Publish to Cloud Docs - Publish your Repo Docs to the Cloud so that anyone from your workspace can review - even if they don't have access to your repo.
  • Changing the Order of Repositories- You can now change the order of repositories displayed on the left-side navigation. To change the order, hover over any repository and drag the repository using the new 8-pin icon. Note, that changing the order only affects your Swimm account and not other members' accounts.
  • Recommended Files to Document - Based on Swimm insights about your repository, we now make recommendations for files that you may wish to document. Recommendations can be found under "Insights" and are a great place to get started.
  • New Documentation Hub - Located on the left navigation panel, Admins can now add links to other documentation sources - all in one place - with Swimm's new Documentation Hub.

Improvements:​

  • Doc from PR - Additions or changes in any package-lock.json or yarn.lock file will not appear in a doc created with the Doc from PR feature.
  • Adding Tags to Doc Drafts - It is now possible to add tags to a doc draft before the doc is committed. Tags are saved in the doc when the draft is committed.
  • Timeout Added to Swimm Verify Checks - A timeout was added to the Swimm Verify check to let users re-run a check which didn't finish due to an internal issue.
  • Slack Notifications - When a user renames an existing doc and commits it, no Slack notifications are sent to the Admin-defined channel in Swimm's Slack app.
  • CodeBlock Syntax Highlighting - Now, CodeBlocks will display a colorful theme and a language selector.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 3 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.5❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Cloud Docs- You can now create and store docs in the Cloud without connecting to a GitHub repository. Cloud Docs are great not just for developers but for any other roles in your organization (such as Customer Support, Sales Engineering, or Product Management) to store knowledge about processes, methodologies, or other internal technical documents such as PRDs, Sprint Retros, or other docs you wish to keep internally across your organization.

Improvements:​

  • Commit Multiple Changes - You can now commit multiple changed documents in a single commit. There is a new section at the top of the home/repo page called "Commit Changes".
  • Video Links - Youtube video links are now automatically embedded as a video player in docs.
  • Tags - You can now easily manage (add, remove, or rename) tags on any of your docs directly from within the Home Page, Everything Page, or from within a specific repository.
  • Assigning Docs - You can now assign a doc to multiple users at the same time, using the existingΒ AssignΒ feature from the doc sidebar area.
  • Creating Docs from PRs - When creating a new doc from a Pull Request and manually entering a PR number, the new doc will be created on the PR branch instead of the default branch.
  • Doc Requests - A doc request will automatically be marked as completed once you've merged its associated doc to the default branch. Note, that this requires installing the Swimm GitHub App.
  • Swimm Verify Check Run - You can rerun an existing Swimm Verify check run via the Swimm GitHub App in cases, for example, when a check run is canceled or if there is an issue with the initial check run.
  • Providing Feedback to Swimm - We improved our feedback form which is available in the Help Center.
  • Keyboard Shortcuts - Improved the keyboard shortcuts section for Swimm’s Editor - also available in the Help Center.
  • Help Articles - The Help Center now has a new section with many helpful articles to help you get started with Swimm.

Bug Fixes:​

  • Fixed when the Swimm GitHub App is installed, but the initialΒ .swm/swimm.jsonΒ file is not merged.
  • Fixed preview mode UI issues with long titles and placeholders on templates.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 2 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.4❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Sharing Doc Drafts- As an admin, you can now let users share doc drafts with teammates. This ability can be configured on a repository level via theΒ Integrations & SettingsΒ page. The default setting is theΒ Local DraftsΒ . Once an admin selects the Cloud Drafts option, new drafts created by any user will be stored in the cloud for 30 days unless committed before then. Users can share a doc draft by clicking the share icon from the top right corner of the edit doc page and clicking on theΒ Copy LinkΒ .

  • Doc & Playlist Creation Hub- Creating new docs has never been easier. Simply click the "New" button on your repo page and see all the options to start creating new documentation.

Improvements:​

  • Viewing and Edit Docs - When viewing or editing a doc with snippets, the referenced files section displays only filenames without their full path. You can still hover on a filename to see the full path.

  • Adding Tags - When adding a tag from a specific doc, the list of workspace tags is ordered alphabetically.

Bug Fixes:​

  • In the GitHub App, when a PR only contains a Swimm doc change without any changes to the code, no Swimm comment will be added to the PR.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 2 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.3❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Introducing Tags: You can add tags on each doc and filter your docs by tag in your repos. When a tag is created, it can be used across all of your workspace repositories. You can also rename, remove, or permanently delete a tag from your workspace by going into a doc and then from the sidebar, hover over the tag. Then, click on the "..." menu to manage your options.

  • Coverage Goals for Repos: Admin can now set a coverage goal for every repo. Check out the new Insights Tab for more repo coverage data and to set your coverage goals.

  • Document Updates Graph: Admins can now see the number of documents that have been updated with Swimm's patented Auto-sync feature.

Improvements:​

  • You can now filter documentation by type (docs or Playlists), file name, stage (committed/pending/draft), and tags.

  • TheΒ IntegrationsΒ page (available to Swimm admins only) was removed. Instead, you can navigate to the newΒ Integrations & SettingsΒ page (contains the same options) from the Home/Repository page via the left sidebar gear icon or via the gear icon next to the repository name.

  • Add Smart Tokens from anywhere in your repo: You will now automatically get suggestions for smart tokens - even for code elements that are not in snippets in a doc!

  • Preview for Smart Token selection: Get a glimpse of where your tokens are taken. The preview window provides more context for the Smart Token you select.

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· 2 min read
Swimm

We're pleased to announce the availability of Swimm 0.9.2❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

  • Mention a Swimm user from your workspace in a doc via the /mention command or by entering @ followed by the user’s name.
  • Watch a doc and get notified when it's been updated.
  • New activity graphs in the Admin view. Admins can now track and learn about member activity in a workspace, including daily sessions and number of docs read.

Improvements:​

  • Faster navigation - a faster navigation process across the app.
  • An Integrations tab is available inside User Settings to install IDE plugins and to connect to Slack in order to receive personal Swimm notifications.
  • The document sidebar is now available when editing a doc (in addition to viewing a doc).
  • When scrolling through a doc that contains headers, the table of contents section in the sidebar automatically points to the active doc content.<
  • Additional auto-syncable cases are recognized by Swimm (docs previously marked as out of date are now recognized as auto-syncable).

For further information and any questions, please reach out to us on our Community Slack Channel.

Β· One min read
Swimm

We're pleased to announce the availability of Swimm 0.9.1❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:​

Table of Contents: A new sidebar located on the right side of your screen, is now available when viewing a doc. The sidebar contains a table of contents section, a section showing referenced files,and general doc metadata such as the doc creation date and date last updated. Click on the table of contents entry to navigate to a specific section in the doc.

Improvements:​

GitHub App: When the Swimm Verify Check setting is enabled from the GitHub app settings and a PR includes Swimm doc changes, you will receive a different Check message clarifying that related Swimm docs have been updated.

Bug Fixes:​

Fixed bugs in the repo connection process.

For further information and any questions, please reach out to us on our Community Slack Channel.