docs(readme): update readme (#3469)

2023-06-12 22:05:01 -04:00 · 2023-06-12 22:05:01 -04:00 · 14369414cf
commit 14369414cf
parent cd1d097957
11 changed files with 112 additions and 60 deletions
--- a/README.md
+++ b/README.md
@ -34,7 +34,14 @@ provided by the <a href="https://ohif.org/">Open Health Imaging Foundation (OHIF
 <!-- [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors) -->
 <!-- prettier-ignore-end -->

-![Alt text](platform/docs/docs/assets/img/OHIF-Viewer.jpg)
+|     |  |
+| :-: | :---  |
+| <img src="platform/docs/docs/assets/img/demo-measurements.jpg" alt="Measurement tracking" width="350"/> | Measurement Tracking |
+| <img src="platform/docs/docs/assets/img/demo-segmentation.png" alt="Segmentations" width="350"/> | Labelmap Segmentations  |
+| <img src="platform/docs/docs/assets/img/demo-ptct.png" alt="Hanging Protocols" width="350"/> | Fusion and Custom Hanging protocols  |
+| <img src="platform/docs/docs/assets/img/demo-microscopy.png" alt="Microscopy" width="350"/> | Slide Microscopy  |
+| <img src="platform/docs/docs/assets/img/demo-volumeRendering.png" alt="Volume Rendering" width="350"/> | Volume Rendering  |
+

 ## About

@ -81,17 +88,14 @@ forking).

 ### Support

-We offer support through
-[GitHub Issues](https://github.com/OHIF/Viewers/issues/new/choose). You can:
-
 - [Report a Bug 🐛](https://github.com/OHIF/Viewers/issues/new?assignees=&labels=Community%3A+Report+%3Abug%3A%2CAwaiting+Reproduction&projects=&template=bug-report.yml&title=%5BBug%5D+)
 - [Request a Feature 🚀](https://github.com/OHIF/Viewers/issues/new?assignees=&labels=Community%3A+Request+%3Ahand%3A&projects=&template=feature-request.yml&title=%5BFeature+Request%5D+)
 - [Ask a Question 🤗](community.ohif.org)
 - [Slack Channel](https://join.slack.com/t/cornerstonejs/shared_invite/zt-1r8xb2zau-dOxlD6jit3TN0Uwf928w9Q)

 For commercial support, academic collaborations, and answers to common
-questions; please read our
-[documented FAQ](https://docs.ohif.org/faq/index.html#does-ohif-offer-commercial-support).
+questions; please use [Get Support](https://ohif.org/get-support/) to contact
+us.


 ## Developing
@ -124,9 +128,6 @@ Here is a schematic representation of our development workflow:



-
-
-
 ### Requirements

 - [Yarn 1.17.3+](https://yarnpkg.com/en/docs/install)
@ -218,15 +219,6 @@ you'll see the following:
 └── README.md                # This file
 ```

-Want to better understand why and how we've structured this repository? Read
-more about it in our [Architecture Documentation][ohif-architecture].
-
-
-
-| Name                                                 | Description                                           | Links                  |
-| ---------------------------------------------------- | ----------------------------------------------------- | ---------------------- |
-| [@ohif/extension-cornerstone][extension-cornerstone] | 2D image viewing, annotation, and segementation tools | [NPM][cornerstone-npm] |
-
 ## Acknowledgments

 To acknowledge the OHIF Viewer in an academic publication, please cite
--- a/platform/docs/docs/README.md
+++ b/platform/docs/docs/README.md
@ -23,7 +23,6 @@ Key features:
  components available in a reusable component library built with React.js and
  Tailwind CSS

-![OHIF Viewer Screenshot](./assets/img/OHIF-Viewer.jpg)

 <div className="text--center">
    <div className="button-group">
@ -35,6 +34,16 @@ Key features:



+|     |  |
+| :-: | :---  |
+| <img src="./assets/img/demo-measurements.jpg" alt="Measurement tracking" width="350"/> | Measurement Tracking |
+| <img src="./assets/img/demo-segmentation.png" alt="Segmentations" width="350"/> | Labelmap Segmentations  |
+| <img src="./assets/img/demo-ptct.png" alt="Hanging Protocols" width="350"/> | Fusion and Custom Hanging protocols  |
+| <img src="./assets/img/demo-microscopy.png" alt="Microscopy" width="350"/> | Slide Microscopy  |
+| <img src="./assets/img/demo-volumeRendering.png" alt="Volume Rendering" width="350"/> | Volume Rendering  |
+
+
+
 ## Where to next?

 The Open Health Imaging Foundation intends to provide an imaging viewer
--- a/platform/docs/docs/assets/img/demo-measurements.jpg
+++ b/platform/docs/docs/assets/img/demo-measurements.jpg
--- a/platform/docs/docs/assets/img/demo-microscopy.png
+++ b/platform/docs/docs/assets/img/demo-microscopy.png
--- a/platform/docs/docs/assets/img/demo-ptct.png
+++ b/platform/docs/docs/assets/img/demo-ptct.png
--- a/platform/docs/docs/assets/img/demo-segmentation.png
+++ b/platform/docs/docs/assets/img/demo-segmentation.png
--- a/platform/docs/docs/assets/img/demo-volumeRendering.png
+++ b/platform/docs/docs/assets/img/demo-volumeRendering.png
--- a/platform/docs/docs/faq.md
+++ b/platform/docs/docs/faq.md
@ -37,11 +37,10 @@ collaborators. We are always happy to hear about new groups interested in using
 the OHIF framework, and may be able to provide development support if the
 proposed collaboration has an impact on cancer research.

-### Does OHIF offer commercial support?
+### Does OHIF offer support?
+
+yes, you can contact us for more information [here](https://ohif.org/get-support)

-The Open Health Imaging Foundation does not offer commercial support, however,
-some community members do offer consulting services. You can search our
-[Community Forum](https://community.ohif.org/) for more information.

 ### Does The OHIF Viewer have [510(k) Clearance][501k-clearance] from the U.S. F.D.A or [CE Marking][ce-marking] from the European Commission?

--- a/platform/docs/docs/release-notes.md
+++ b/platform/docs/docs/release-notes.md
@ -5,14 +5,83 @@ sidebar_label: Release Notes

 # Release Notes

-> New `OHIF-v3` architecture has made OHIF a general purpose extensible medical
-> imaging **platform**, as opposed to a configurable viewer.

-## What's new in `OHIF-v3`
+## Current Release (master branch)

-`OHIF-v3` is our second try for a React-based viewer, and is the third version
-of our medical image web viewers from the start. The summary of changes includes:
+### OHIF Viewer v3.6 - Official Version 3 Release (June 2023)

+Check out the complete press announcement [here](https://ohif.org/newsletters/2023-06-08-ohif%20viewer%20v3%20official%20release%20&%20new%20nci%20funding--release).
+
+- Official OHIF v3 release: An important milestone achieved with OHIF v3 now at feature parity with v2 but with a more extensible and powerful framework.
+
+New Features:
+
+- DICOM Radiotherapy Structure Sets: Enhancement of DICOM RTSTRUCT rendering pipeline to better integrate with other segmentation types.
+- Slide Microscopy: Slide microscopy code updated with the latest technologies from the DICOM Microscopy Library and SLIM Viewer.
+- DICOM Uploader: New feature to easily upload DICOM files directly from the viewer to their PACS systems over DICOMWeb.
+- Cornerstone DICOM Image Loader Migrated to TypeScript: Transition to the new TypeScript-based DICOM Image Loader library.
+- Cornerstone3D 1.0 Release: Announcement of Cornerstone3D reaching version 1.0, indicating its readiness for production use.
+
+## Previous V3 Releases (on `v3-stable` branch, before merge to `master`)
+
+### OHIF Viewer v3.5 - Docker Build
+
+This update represents a minor release that is primarily focused on enhancing the development environment of the OHIF Viewer. It achieves this by integrating Docker build support, which is essential for streamlining the deployment process and ensuring consistent environments. Additionally, in an effort to optimize the development workflow, this release takes care of pushing changes to the master branch. Furthermore, it strategically splits the master branch from the release branch. This separation is crucial as it allows the developers to work more efficiently on the ongoing developments in the master branch, while simultaneously ensuring that the release branch remains stable and well-maintained. Such an approach underlines the commitment to both innovation and reliability.
+
+
+### OHIF Viewer v3.4 - Segmentation Support (April 2023)
+Check out the complete press announcement [here](https://ohif.org/newsletters/2023-04-03-new%20product%20features,%20grant%20updates%20and%20collaborations).
+
+- New Viewport State Preservation: Enhancements in state synchronization in OHIF Viewer for a seamless experience when switching between Multiplanar Reformatting (MPR) and other views.
+
+- Enhanced Hanging Protocol Matching: Improved hanging protocols for a faster, more user-friendly experience.
+
+- Customizable Context Menu: Expansion of context menu options allowing for greater customization and addition of sub-menus.
+
+- UI/UX Improvements: Revamped viewport header design and the addition of double-click functionality to maximize viewport.
+
+### OHIF Viewer v3.3 - Segmentation Support (November 2022)
+
+Check out the complete press announcement [here](https://ohif.org/newsletters/2022-11-21-ohif%20viewer:%20dicom%20segmentation%20support).
+
+- 3D Segmentation: Segmentations are natively loaded and rendered in 3D. The UI includes various interaction tools and rendering display preferences. Segmentation creation and editing tools are in development.
+
+- Fast and Optimized Multiplanar Reconstruction (MPR): The viewer now supports MPR visualization of volumes and segmentations, leading to significantly reduced memory footprint and improved performance.
+
+- New Collapsible Side Panels: The OHIF Viewer has redesigned side panels to be more compact and user friendly.
+
+- Context-aware Drag and Drop via Hanging Protocols: The viewer now allows a more seamless experience when dragging and dropping thumbnails.
+
+- New Tools: Two new tools have been added: Reference Lines and Stack Synchronizations.
+
+
+
+### OHIF Viewer v3.2 - Mode Gallery & TMTV Mode (August 2022)
+
+Check out the complete press announcement [here](https://ohif.org/newsletters/2022-08-18-mode%20gallery%20and%20tmtv%20mode).
+
+- New Total Metabolic Tumor Volume (TMTV) Workflow: This new mode includes high-performance rendering of volumetric data in ten distinct viewports, fusion of two series with adjustable colormaps, synchronization of the viewports for both camera and VOI settings, jump-to-click capability to synchronize navigation in all viewports, and support for exporting results.
+
+- OHIF Workflow Mode Gallery: This new feature is a one-stop shop for users to find, install, and use OHIF modes and share functionality with the community. The gallery is continuously updated with community-submitted modes.
+
+
+### OHIF Viewer v3.1 - Cornerstone3D Integration (July 2022)
+
+Check out the complete press announcement [here](https://ohif.org/newsletters/2022-07-28-ohif%20&%20cornerstone3d%20integratione).
+
+- Cornerstone3D Integration: OHIF v3.1 has deprecated the legacy Cornerstone.js extension and replaced all functionality with Cornerstone3D. This includes updating the Measurement Tracking workflow mode.
+
+- GPU Accelerated 2D Rendering: The Cornerstone3D rendering engine now supports WebGL 2D textures for large images, increasing the interaction speed significantly compared to the legacy Cornerstone.js engine.
+
+- Upgraded Hanging Protocol Engine: The OHIF Hanging Protocol Engine has been updated for increased flexibility and ease of writing protocols. This includes the ability to position viewports in any non-grid layout and specify viewport configurations such as colormap, initial VOI, initial image to render, orientation, and more.
+
+
+### OHIF Viewer v3.0 Public Beta Launch (September 2021)
+
+Check out the complete press announcement [here](https://ohif.org/newsletters/2021-09-14-ohif%20update:%20v3%20public%20beta%20launch--release).
+
+- UI has been completely redesigned with modularity and workflow modes in mind.
+- New UI components have been built with Tailwind CSS
 - Addition of workflow modes
  - Often, medical imaging use cases involves lots of specific workflows that
    re-use functionalities. We have added the capability of workflow modes, that
@ -25,14 +94,11 @@ of our medical image web viewers from the start. The summary of changes includes
  - Our vision is that technical people focus of developing extensions which
    provides core functionalities, and experts to build modes by picking the
    appropriate functionalities from each extension.
-  - Migrated all the `cornerstone-core` and `cornerstone-tools` usage to the newly released `Cornerstone3D`.

-* UI has been completely redesigned with modularity and workflow modes in mind.
-* New UI components have been built with Tailwind CSS
-* Redux store has been removed from the viewer in favour of services backed by
-  React's Context **API**

-Below, you can find the gap analysis between the `OHIF-v2` and `OHIF-v3`:
+
+
+<!-- Below, you can find the gap analysis between the `OHIF-v2` and `OHIF-v3`:

 <table>
    <thead>
@ -138,4 +204,4 @@ Below, you can find the gap analysis between the `OHIF-v2` and `OHIF-v3`:
        <td align="center">The problem is that this breaks a bunch of extensions that rely on third party scripts (e.g. VTK) which have their own web worker loaders.</td>
    </tr>
 </tbody>
-</table>
+</table> -->
--- a/platform/docs/docusaurus.config.js
+++ b/platform/docs/docusaurus.config.js
@ -80,12 +80,6 @@ module.exports = {
  plugins: [
    path.resolve(__dirname, './pluginOHIFWebpackConfig.js'),
    'plugin-image-zoom', // 3rd party plugin for image click to pop
-    [
-      '@docusaurus/plugin-google-gtag',
-      {
-        trackingID: 'UA-110573590-2',
-      },
-    ],
    [
      '@docusaurus/plugin-client-redirects',
      {
@ -240,6 +234,10 @@ module.exports = {
        theme: {
          customCss: [require.resolve('./src/css/custom.css')],
        },
+        gtag: {
+          trackingID: 'G-DDBJFE34EG',
+          anonymizeIP: true,
+        },
      }),
    ],
  ],
@ -285,14 +283,8 @@ module.exports = {
        },
        items: [
          {
-            to: 'https://ohif.org/get-started',
-            label: 'Get Started',
-            target: '_blank',
-            position: 'left',
-          },
-          {
-            to: 'https://ohif.org/examples',
-            label: 'Examples',
+            to: 'https://ohif.org/showcase',
+            label: 'Showcase',
            target: '_blank',
            position: 'left',
          },
@ -304,8 +296,8 @@ module.exports = {
            label: 'Docs',
          },
          {
-            to: 'https://ohif.org/community',
-            label: 'Community',
+            to: 'https://ohif.org/collaborate',
+            label: 'Collaborate',
            target: '_blank',
            position: 'left',
          },
--- a/platform/docs/src/pages/help.md
+++ b/platform/docs/src/pages/help.md
@ -3,7 +3,7 @@
 We all need a little help sometimes. Don't let a few roadblocks stand in the way
 of you building something awesome.

-## Community Support
+## Get Support

 If you're a developer looking to contribute code, documentation, or discussion;
 we are more than happy to help provide clarification and answer questions via
@ -21,15 +21,9 @@ resources and must be judicious with how we allocate them. If you find yourself
 in this situation and in need of assistance, it may be in your best interest to
 persue paid support.

-## Commercial Support
+If you need additional help, please [reach out to us](https://ohif.org/get-support) to get more information on
+how we can help you.

-The Open Health Imaging Foundation does not offer commercial support, however,
-some community members do offer consulting services. You can search our
-[Community Forum](https://community.ohif.org/) for more information.
-
-<!--
-  Links
-  -->

 [gh-issues]: https://github.com/OHIF/Viewers/issues/
 [google-group]: https://groups.google.com/forum/#!forum/cornerstone-platform