diff --git a/README.md b/README.md
index 7166afb4cfd..c81ec79ce9e 100644
--- a/README.md
+++ b/README.md
@@ -19,14 +19,13 @@ provided by the Open Health Imaging Foundation (OHIF
-
[![NPM version][npm-version-image]][npm-url]
-[![NPM downloads][npm-downloads-image]][npm-url]
-[![Pulls][docker-pulls-img]][docker-image-url]
[![MIT License][license-image]][license-url]
[![This project is using Percy.io for visual regression testing.][percy-image]](percy-url)
+
+
@@ -35,6 +34,8 @@ provided by the Open Health Imaging Foundation (OHIF
+
+
## About
The OHIF Medical Imaging Viewer is for viewing medical images. It can retrieve
@@ -95,6 +96,37 @@ questions; please read our
## Developing
+### Branches
+
+#### `master` branch - The latest dev (beta) release
+
+- `master` - The latest dev release
+
+This is typically where the latest development happens. Code that is in the master branch has passed code reviews and automated tests, but it may not be deemed ready for production. This branch usually contains the most recent changes and features being worked on by the development team. It's often the starting point for creating feature branches (where new features are developed) and hotfix branches (for urgent fixes).
+
+Each package is tagged with beta version numbers, and published to npm such as `@ohif/ui@3.6.0-beta.1`
+
+### `release` branch - The latest stable release
+
+This branch represents the latest stable version of the project that is considered ready for production. The code in this branch should be fully tested and vetted for release. Once the code in the master branch reaches a state where it's stable and ready to be released to users,
+we do a comprehensive code review and QA testing. Once the code is approved,
+we merge it into the release branch and tag a new release.
+
+Each package is tagged with version numbers, and published to npm such as `@ohif/ui@3.5.0`
+
+Note: `master` is always ahead of `release` branch. We publish both docker builds for beta and stable releases.
+
+Here is a schematic representation of our development workflow:
+
+
+
+
+
+
+
+
+
+
### Requirements
- [Yarn 1.17.3+](https://yarnpkg.com/en/docs/install)
@@ -261,7 +293,7 @@ MIT © [OHIF](https://github.com/OHIF)
[npm-downloads-image]: https://img.shields.io/npm/dm/@ohif/app.svg?style=flat-square
[npm-version-image]: https://img.shields.io/npm/v/@ohif/app.svg?style=flat-square
[docker-pulls-img]: https://img.shields.io/docker/pulls/ohif/viewer.svg?style=flat-square
-[docker-image-url]: https://hub.docker.com/r/ohif/viewer
+[docker-image-url]: https://hub.docker.com/r/ohif/app
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license-url]: LICENSE
[percy-image]: https://percy.io/static/images/percy-badge.svg
diff --git a/extensions/cornerstone/src/services/SegmentationService/SegmentationService.ts b/extensions/cornerstone/src/services/SegmentationService/SegmentationService.ts
index 220b188cb98..c03b0569860 100644
--- a/extensions/cornerstone/src/services/SegmentationService/SegmentationService.ts
+++ b/extensions/cornerstone/src/services/SegmentationService/SegmentationService.ts
@@ -117,7 +117,7 @@ class SegmentationService extends PubSubService {
* -- opacity: the opacity of the segment
* -- visibility: the visibility of the segment (boolean)
* -- isLocked: whether the segment is locked for editing
- * -- active: whether the segment is currently the active segment to be edited
+ * -- active: whether the segment is currently the active segment to be edited or not
*/
public addSegment(
segmentationId: string,
diff --git a/platform/app/public/init-service-worker.js b/platform/app/public/init-service-worker.js
index 0278c5747f2..246d423d7dd 100644
--- a/platform/app/public/init-service-worker.js
+++ b/platform/app/public/init-service-worker.js
@@ -1,3 +1,9 @@
+navigator.serviceWorker.getRegistrations().then(function(registrations) {
+ for (let registration of registrations) {
+ registration.unregister();
+ }
+});
+
// https://developers.google.com/web/tools/workbox/modules/workbox-window
// All major browsers that support service worker also support native JavaScript
// modules, so it's perfectly fine to serve this code to any browsers
@@ -5,7 +11,7 @@
//
//import { Workbox } from './workbox-window.prod.mjs';
// proper initialization
-if( 'function' === typeof importScripts) {
+if ('function' === typeof importScripts) {
importScripts(
'https://storage.googleapis.com/workbox-cdn/releases/6.5.4/workbox-window.prod.mjs'
);
@@ -55,5 +61,4 @@ if( 'function' === typeof importScripts) {
wb.register();
}
-
}
diff --git a/platform/app/src/service-worker.js b/platform/app/src/service-worker.js
index 51566aba8e1..e97198b4101 100644
--- a/platform/app/src/service-worker.js
+++ b/platform/app/src/service-worker.js
@@ -1,3 +1,9 @@
+navigator.serviceWorker.getRegistrations().then(function(registrations) {
+ for (let registration of registrations) {
+ registration.unregister();
+ }
+});
+
// https://developers.google.com/web/tools/workbox/guides/troubleshoot-and-debug
importScripts(
'https://storage.googleapis.com/workbox-cdn/releases/5.0.0-beta.1/workbox-sw.js'
diff --git a/platform/docs/docs/assets/img/github-readme-branches.png b/platform/docs/docs/assets/img/github-readme-branches.png
new file mode 100644
index 00000000000..271001a473d
Binary files /dev/null and b/platform/docs/docs/assets/img/github-readme-branches.png differ
diff --git a/platform/docs/docs/development/getting-started.md b/platform/docs/docs/development/getting-started.md
index 054d5f72e80..5f631a5d310 100644
--- a/platform/docs/docs/development/getting-started.md
+++ b/platform/docs/docs/development/getting-started.md
@@ -40,6 +40,31 @@ aren't as concerned with syncing updates, then follow these steps:
## Developing
+### Branches
+
+#### `master` branch - The latest dev (beta) release
+
+- `master` - The latest dev release
+
+This is typically where the latest development happens. Code that is in the master branch has passed code reviews and automated tests, but it may not be deemed ready for production. This branch usually contains the most recent changes and features being worked on by the development team. It's often the starting point for creating feature branches (where new features are developed) and hotfix branches (for urgent fixes).
+
+Each package is tagged with beta version numbers, and published to npm such as `@ohif/ui@3.6.0-beta.1`
+
+### `release` branch - The latest stable release
+
+This branch represents the latest stable version of the project that is considered ready for production. The code in this branch should be fully tested and vetted for release. Once the code in the master branch reaches a state where it's stable and ready to be released to users,
+we do a comprehensive code review and QA testing. Once the code is approved,
+we merge it into the release branch and tag a new release.
+
+Each package is tagged with version numbers, and published to npm such as `@ohif/ui@3.5.0`
+
+Note: `master` is always ahead of `release` branch. We publish both docker builds for beta and stable releases.
+
+Here is a schematic representation of our development workflow:
+
+
+
+
### Requirements
- [Node.js & NPM](https://nodejs.org/en/)
diff --git a/platform/docs/docusaurus.config.js b/platform/docs/docusaurus.config.js
index 3d080da6613..9e6611c2ce1 100644
--- a/platform/docs/docusaurus.config.js
+++ b/platform/docs/docusaurus.config.js
@@ -235,9 +235,6 @@ module.exports = {
current: {
label: 'Latest',
},
- '2.0': {
- label: 'Version 2.0 - Master branch',
- },
},
},
theme: {
diff --git a/platform/ui/src/components/AboutModal/AboutModal.tsx b/platform/ui/src/components/AboutModal/AboutModal.tsx
index cc8de6e288d..84d055cf799 100644
--- a/platform/ui/src/components/AboutModal/AboutModal.tsx
+++ b/platform/ui/src/components/AboutModal/AboutModal.tsx
@@ -83,6 +83,11 @@ const AboutModal = ({ buildNumber, versionNumber, commitHash }) => {
value="https://github.com/OHIF/Viewers/"
link="https://github.com/OHIF/Viewers/"
/>
+ |
{/*