Skip to main content

Swimm 1.0.7 Released

Β· 2 min read
Swimm
Swimm Development Team

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

Improvements:​

  • Swimm Notifications - All users are notified by email when users join or leave a workspace.
  • Web App Refresh - We automatically prompt to refresh the web app after deploying a new version.
  • Join Workspace - We have improved the performance of users joining a workspace.
  • Editing Docs - We are continuing to create a smoother experience editing docs.
  • Reviewing Docs - When clicking an item that needs review, you can now see all relevant items in the view mode.
  • sw.md Format - We have upgraded our sw.md file format so that it's a more efficient, providing a smoother user experience.
  • Stigg/Stripe - We have made modifications to Swimm's billing and payment system.
  • Sign up to Swimm - We have improved the signing up process for Swimm.

Bug fixes​

  • Fixed: Repo lists no longer display every repo twice after closing and opening again.
  • Fixed: GitHub App bugs.
  • Fixed: IntelliJ plugin issue when canceling a login.
  • Fixes: Help for editor commands is now clickable.

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

Swimm 1.0.0 Released

Β· 2 min read
Swimm
Swimm Development Team

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

Improvements:​

  • sw.md Format - We changed the separation of sw.md information from Smart Tokens, which was causing broken and empty tokens. Now Swimm keeps the text of the token along with its metadata with a ghost HTML tag which is invisible to users but holds all the data needed.
  • Auto-sync - Auto-sync algorithm improved, improving accuracy on Auto-syncable snippets.
  • App Sidebar - Added sidebar across the app for a more robust and stable performance.
  • Creation Hub - Made changes to Swimm's Creation Hub.
  • Code Snippets - Added an action to show less context for code snippets.

Bug fixes​

  • Fixed: Editor sidebar no longer collapses when moving between steps.
  • Fixed: The status page for the progress bar for repos without documentation.
  • Fixed: New workspaces are now created with counters for admins and users.
  • Fixed: Clicking links in workspaces no longer invites the user to join the workspace.
  • Fixed: Displaying of Smart Paths and Smart Tokens.
  • Fixed: Playlists
    • Now shows the step types.
    • Steps in the progress bar appear as selected when editing Playlist pages.
    • Discarding doc drafts while editing Playlists.
  • Fixed: Adding repo button icon.
  • Fixed: Auto-sync algorithm no longer takes up too many lines.
  • Fixed: Editor function for Smart Tokens
    • Smart Tokens ending with brackets are now saved correctly.
    • Smart Tokens with new lines before them.

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

Swimm 0.11.0 Released

Β· 3 min read
Swimm
Swimm Development Team

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

New features:​

  • Multi-Repo Tokens and Paths - You can now add Smart tokens in any document that refers to code in any other repository.
  • Navigation to a New Pull Request Tab - You can now navigate to a new pull request tab when you commit to a new branch and open a PR.

Improvements:​

  • New JetBrains Plugin - Check out the improvements in Swimm's JetBrains plugin. Users can sign up or log in via the IDE. Access Swimm docs directly from the code snippet area and use Swimm's Web App code-coupled editor. Auto-sync is fully supported.
  • Swimm's IDE Plugins - We have improved the stability of the IDE plugins.
  • Auto-sync Algorithm - Improved Swimm's patented Auto-sync algorithm.

Bug fixes​

  • Fixed: Saving a table that has a top row.
  • Fixed: Code blocks inside table cells.
  • Fixed: Long wait for the status page to load.
  • Fixed: up to date snippet line numbers.
  • Fixed: Auto-sync with multi-repo docs with the same file name.
  • Fixed: Smart Tokens changed to sw.md no longer deletes tokens.
    • Including using a slash.
    • Reordering draft breaks for Playlists in the App.
    • Automatic creation of an untitled Playlist when editing a Playlist.
    • Duplicated docs after saving a Playlists with two new docs.
    • Time to open existing Playlist docs or a draft doc from a Playlist.
    • Refresh in Playlist shows all steps as available.
  • Fixed: Batch commits after refreshing edit docs from templates.
  • Fixed: Drafts with an outdated snippet are no longer all outdated.
  • Fixed: Preventing collisions in token keys in store with multi-repo docs.
  • Fixed: JetBrains Rider Server Exception while sending folder structure to the server.
  • Fixed: Deleting docs and Playlists with a PR creation unchecked so that a PR is not created.
  • Fixed: Editor line menu is no longer cut off on small screens.
  • Fixed: The "Create Template" button is no longer enabled if the templates are not loaded.
  • Fixed: "More tags" and "Manage tags" are fixed.
  • Fixed: Drafts are now being saved and no longer deleted.
  • Fixed: Copying and pasting global tokens now works between two tabs or documents.
  • Fixed: Editor no longer ignores token suggestions for onboarding docs.
  • Fixed: Tabs in the Web App on the home and repo pages are responsive when clicking forward and backward.
  • Fixed: Deleted docs no longer appear after deleting them.
  • Fixed: IntelliJ improvements and bug fixes.
  • Fixed: Can now delete a doc from the doc list on repo pages.
  • Fixed: Home page sidebar buttons and menu are now disabled.
  • Fixed: Moving to different workspaces from a repo page.
  • Fixed: Search modal is no longer open if we click on search results.
  • Fixed: Improved loading time for loading the repo list in the sidebar.
  • Fixed: Snippet Studio line numbers of source files when selecting a snippet are correct.
  • Fixed: Block possible XSS.

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

Swimm 0.10.2 Released

Β· 2 min read
Swimm
Swimm Development Team

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

Improvements:​

  • Unified Workspace Settings - The Edit Workspace, Billing & Plans, and Invite pages are now merged into a single workspace settings area, available in the bottom-left corner.
  • Viewing and Editing Docs - Performance is smoother when switching between viewing and editing docs.
  • Reverting Draft Changes from Batch Commits - A committed change can now be discarded by reverting draft changes from the batch commit modal located in the top right corner of the repository page.
  • Editor Diagram Examples - Select a diagram template (e.g., sequence diagram, flow chart, etc..) and start editing the code.
  • Editing Playlists - When you edit a Playlist, if you remove a blank doc from the Playlist, the doc will be discarded, and the documentation step will be removed from the Playlist.
  • Streamlined Searching - Improved searching with the search modal in repos and not only in workspaces.
  • Deleting Documentation - You can now delete documentation from a search result.
  • Home Page Doc Creation - You can now create a doc from the home page.

Bug fixes:​

  • Fixed: issue using templates in a Playlist.

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

Swimm 0.10.1 Released

Β· 2 min read
Swimm
Swimm Development Team

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

New features:​

  • Pull Request Tab in the Repo Page - You can now see PRs from GitHub that have documentation changes. Each block is a PR, and you can see the new docs and all changes (edits and deletions) that are waiting to be merged to a branch.
  • New Features in the VS Code Extension - We have created new features in our VS Code extension including a new welcome screen for registration, login, and other common actions. Also, Swimm's code-coupled editor includes being able to view live snippets, Smart Tokens, and use all the features that are currently available in Swimm's web application so that you can switch back and forth from docs to code seamlessly.

Improvements:​

  • Fresh New Look for Swimm's App - Check out and explore the new look for Swimm's app. You can navigate to the global menu to search, change your settings, and get notifications. Also, find your workspace docs in one consolidated spot now, including Repo and Cloud Docs.
  • Committing Docs - We have improved the performance for committing docs and have added a progress bar.
  • Repo Page Loading - We have improved the performance for loading repo pages.
  • Creating New Playlists - We have improved the performance for creating new Playlists.
  • Copying and Pasting Between Docs - You can now copy and paste snippets, Smart Tokens, and Smart Paths between different documents in different tabs.

Bug fixes:​

  • Fixed: you can now select text inside code snippets and code blocks.

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

Swimm 0.10.0 Released

Β· One min read
Swimm
Swimm Development Team

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.

Swimm 0.9.9 Released

Β· One min read
Swimm
Swimm Development Team

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.

Swimm 0.9.8 Released

Β· 3 min read
Swimm
Swimm Development Team

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.

Swimm 0.9.7 Released

Β· 3 min read
Swimm
Swimm Development Team

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.

Swimm 0.9.6 Released

Β· 2 min read
Swimm
Swimm Development Team

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.