Skip to main content

21 posts tagged with "release-notes"

View All Tags

Β· 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.
  • Publish to Cloud Docs - Publish your repo docs to the cloud for anyone from your workspace to view, even if they don't have access to your repo.

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.

Β· 2 min read
Swimm

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

New Features:

  • Introducing our new Slack App to make it easier for you and your team to stay updated with Swimm! With the Swimm Slack app, once you connect your repo to a Slack channel, you will automatically be notified whenever a new doc is merged to your default branch. As an admin, just go to theΒ IntegrationsΒ page and click theΒ InstallΒ button next to Slack.
  • We now support Documents and Playlists list view. You can view more documents in the list view at once with relevant information in each column. You always have the option to switch back to the previous card layout.
  • You can now control personalized email, Slack, and in-app notifications when an important action affecting you occurs. The new notifications area can be accessed fromΒ Profile > User Settings > Notifications.

Improvements:

  • App Facelift: We’ve made changes and improvements to Swimm's app including viewing workspace related stats on the Home Page. Note that all of your documents are still available under Everything.
  • Removed theΒ Mark as ReadΒ button from docs. It is still available inside Playlists.
  • Improved the Swimm Editor writing flow
    • Every line is draggable
    • Snippets and images can now be inserted everywhere
  • Improved pasting of Markdown and HTML content
    • With new shortcuts (cmd + v and cmd + shift + v)
  • Added a contextual menu to each line in the document
  • Created new shortcuts moving content up and down (ctrl + shift + up and ctrl + shift + down)

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.8.8❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:

  • Request a Doc: You can now request a doc and assign it to a member of your team. You can find the list of all requested documents in the new β€œDoc Requests” tab under a repository. Doc requests are marked as completed once they are written.
  • Demo Workspace: Check out Swimm's Demo Workspace to get inspired with real documentation written by our engineering team. Access Swimm's Demo Workspace via the Help Center.

Improvements:

  • Enhanced Signup Process: When new users sign up for Swimm, they can now request to join their company's existing workspace. Note that this feature is only available if you sign up with Google.

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.8.6❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:

  • After reviewing a doc, you can now send a quick thank you to everyone who contributed to creating that document. At the bottom of the document, there are 3 options you can pick: great doc, time-saver, and valuable insights.
  • You can assign a doc to a Swimm user or email address via the Assign link located below the document title. You can choose from a predefined set of reasons (needs review, needs updating, FYI, other) and assign it and include an optional note. After assigning a doc, the assignee will receive an email with the assignment details.
  • You can obtain and share a direct link to a code snippet with the anchor icon located at the top-right corner of a snippet.
  • Introducing a new GitHub App setting called Configure Swimm Verify Check . When enabled, Swimm will fail only when outdated/out of sync docs are caused by your current PR. When disabled (default), Swimm will show updates related to any outdated/out of sync docs.

Improvements:

  • You can see a list of all contributors on a doc (not only the last contributor) when viewing a doc.

A few changes in our editor

  • Slash command "/link" changed into 2 commands: "/doc" and "/playlist" to add links to these items specifically.
  • Typing "Enter" creates a new block which results in a more fluid and smooth editing experience.
  • A new contextual menu when clicking the block handle icon shows the block options.

Bug Fixes:

  • When "Swimm Verify Check" configuration checkbox is enabled with a PR from a side-branch of a side-branch - Swimm Verify didn't behave correctly

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.8.4❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

Improvements:

  • Performance enhancements when connecting a repo to Swimm.
  • Auto-sync performance enhancements when viewing or editing a doc.
  • When viewing a doc, the last contributor is displayed in addition to the doc creator.
  • When viewing the Workspace Member's List and hovering over a user's name, the user's email is displayed.

Bug Fixes:

  • Fixed missing repos issue.
  • Long branch names are correctly displayed via a tooltip.

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.8.2❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:

  • You can set your snippet view's default to be expanded or collapsed.
  • Swimm GitHub app: You can now configure Swimm to automatically create a draft from your latest PR and show you Swimm Recommended Docs. Go to your repo’s GitHub App Settings and enable the new Allow Swimm the option to add a comment with Swimm Recommended Docs checkbox under Customize PR Comments.
  • You can join the Swimm Community channel from within the Help section.

Improvements:

  • Performance boost for opening a document and Playlist.
  • Auto-complete suggestion supports tokens with -, :, and \.

Bug Fixes:

  • Tokens that are copy pasted are rendered properly.
  • Swimm will automatically save a draft when a Smart Path is approved or reselected.

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.8.0❗ πŸŒŠπŸš’πŸŠπŸš€πŸ†•πŸ’₯πŸŽ‰βœ¨

New Features:

  • You can now use Google Sign-In to sign up or login to Swimm.

Bug Fixes:

  • You can now select Smart Tokens from a TypeScript-based repository.

If you have any questions or issues, please reach out on our Community Slack Channel.

Β· One min read
Swimm

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

Improvements:

  • The Published tab and all labels named Published were renamed to Committed.

Bug Fixes:

  • GitHub App: Outdated docs will not appear in the Recommended Docs section.

If you have any questions or issues, please reach out on our Community Slack Channel.

Β· One min read
Swimm

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

New Features:

  • Capability to add Giphy into your documents

If you have any questions or issues, please reach out on our Community Slack Channel.

Β· One min read
Swimm

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

New Features:

  • Members can directly request to join a workspace from a PR comment or Github Check, and admins will get notified.
  • See a list of recommended docs referencing the same code in the Github Check
  • Ability to add tables in your documents
  • Capability to view the published version of a doc while you're editing it

Improvements:

  • Docs can be filtered as draft, pending, or published
  • Local draft documents are preserved even when you logged out.

If you have any questions or issues, please reach out on our Community Slack Channel.

Β· One min read
Swimm

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

New Features:

  • Introducing GitHub App Auto-sync approval! You can now approve all auto-synced suggestions on a Pull Request with a click of a button directly from GitHub. Check out our new Pull Request comment and Checks section.

Improvements:

  • Swimm Links can optionally be opened in a new window.
  • Document drafts can now be saved on any branch.

Bug Fixes and Deprecations:

  • Since February 9, 2022 - Quick β€œLogin with GitHub” option is no longer available when you sign into Swimm.

If you have any questions or issues, please reach out on our Community Slack Channel.

Β· One min read
Swimm

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

Improvements:

  • Performance of viewing Swimm Docs has improved.
  • Performance of "Commit to branch" action has improved.
  • Review of outdated/auto-synced smart paths now possible.
  • Support for .swm files is now deprecated.

Bug Fixes:

  • IntelliJ Plugin: Fixed issue where in some cases the lifebuoy was not displayed.
  • IntelliJ Plugin: Fixed issue where switching between branches led to an error.

If you have any questions or issues, please reach out on our Community Slack Channel.

Β· 2 min read
Swimm

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

New Features:

  • Playlist DAC (Docs As Code) improvements & finalizations. Please report any issues!
  • Pre-commit hooks version 0.7 released, now automatically downloads the correct CLI binary and supports opening issues on failure via webhook.
  • New documentation and developer community site: docs.swimm.io

Improvements:

  • Snippet Studio now allows you to reselect snippets from other files (for cases where the code actually moved to another file).
  • Branch selector menu is now easier to use for those that have many different branches.
  • Automation tools (such as CLI binaries) are now served from Firebase, not Github. This solves intermittent rate-limiting issues.
  • External links in Swimm content now open in a new tab by default.

Bug Fixes:

  • Fixed an issue where copying smart text resulted in an extraneous ')'.
  • Fixed issue with Docker files in smart text causing reference issues.
  • Fixed issue where adding a repo caused all of them to show up as loading.
  • Fixed issue where loading animations stopped while things were still loading.

If you have any questions or issues, please reach out on our Community Slack Channel. You can also drop in during our next office hours event. We hope to see you there!

Β· One min read
Swimm
Tim Post

We're very thrilled to launch our new developer documentation and community portal using the immensely flexible and feature rich Docusaurus to manage all of the content.

Along, with detailed documentation, videos and tutorials, you'll find detailed release notes for every Swimm Release, as well as news about our other tools, such as our IDE Plugins or Github App.

You can pull RSS or Atom feeds to stay up-to-date:
https://docs.swimm.io/changelog/rss.xml

Swimm generally releases at the beginning of every week, so you can expect updates to be pretty low volume. There will also be a note if new tutorials are added, or any other features that impact the functionality of this site. Major new features and announcements can be found on our main blog.

Please consider checking our our community info and consider joining our Community Slack Channel, or dropping in during our next office hours.

Please have a look at the code of conduct; we want everyone to feel welcome and safe and get value from attending.

Thanks for your interest in Swimm!

Β· One min read
Swimm

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

New Features:

  • Swimm Playlists are now DAC (docs as code) and saved in the swm.md format.
  • Much more intuitive and guided onboarding experience from signup to merging.

Improvements:

  • CI Integration sample configurations updated with packed CLI binary location.
  • External links in Swimm content now open in a new tab by default.

Bug Fixes:

  • Fixed keyboard shortcuts menu mismatch.
  • Fixed an issue in the VSCode IDE Plugin that prevented the explorer view from populating.
  • Fixed issue where /link in the editor wasn't scoping docs correctly without refreshing.
  • Fixed scenario where Mac command key was causing inadvertent saves while editing.

If you have any questions or issues, please reach out on our Community Slack Channel. You can also drop in during our next office hours event. We hope to see you there!

Β· 2 min read
Swimm

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

Release notes are below this short feature spotlight:

New Features:

  • New fluid editor features are deisgned to keep your hands on the keyboard as much as possible while you're writing.
  • Swimm documents can now be converted to Markdown on the fly.
  • Read documentation inline with code from within VSCode!
  • Code auto-completion based on snippets (triggered by backticks)
  • Pre-commit hooks are now avilable for Swimm verification.

Improvements:

  • Markdown rendering now waits until after a space appears after the text.
  • Documents now show their author under the title.
  • Performance tweaks in routes that were taking longer than others to load.

Bug Fixes:

  • Fixed issue where repositories weren't visible to all users.
  • Fixed UX glitch where it was not obvious how to close the support flyout.
  • Fixed issue where some docs had double headers when viewed in playlists.
  • Fixed issue with flickering upon signup (it's now a two-step process).

If you have any questions or issues, please reach out on our Community Slack Channel. You can also drop in during our next office hours event. We hope to see you there!

We have a thread about this release going on Twitter, if you'd like to join in: