docs: update to next version [BUMP BETA] (#4493)

platform/docs/docs/README.md

@@ -24,10 +24,28 @@ Key features:
   Tailwind CSS
 
 
-<div className="text--center">
-    <div className="button-group">
-        <a className='button button--primary' href="https://ohif.org/news/">Subscribe to our newsletter</a>
-        <a className='button button--primary' href="./release-notes">Release Notes</a>
+<div style={{ textAlign: 'center' }}>
+    <div style={{ display: 'flex', gap: '1rem', justifyContent: 'center' }}>
+        <a style={{
+            backgroundColor: '#4042af',
+            color: 'white',
+            padding: '0.5rem 1rem',
+            borderRadius: '0.25rem',
+            textDecoration: 'none',
+            ':hover': {
+                backgroundColor: '#2a2b74'
+            }
+        }} href="https://ohif.org/news/">Subscribe to our newsletter</a>
+        <a style={{
+            backgroundColor: '#4042af',
+            color: 'white',
+            padding: '0.5rem 1rem',
+            borderRadius: '0.25rem',
+            textDecoration: 'none',
+            ':hover': {
+                backgroundColor: '#2a2b74'
+            }
+        }} href="./release-notes">Release Notes</a>
     </div>
 </div>
 

platform/docs/docs/resources.md

@@ -11,6 +11,9 @@ and other resources that we have provided to the community in the past:
 
 ## 2024
 
+
+
+
 ### IMNO 2024 - March 19-20, 2024
 
 We participated in the Imaging Network Ontario (ImNO) 2024 symposium, presenting three posters. One of our presentations received the best talk award during the session.

platform/docs/docusaurus.config.js

@@ -13,12 +13,17 @@ const versions = fs.readFileSync('../../version.txt', 'utf8').split('\n');
 
 const ArchivedVersionsDropdownItems = [
   {
-    version: '2.0-deprecated',
+    version: '3.8.5',
+    href: 'https://v3p8.docs.ohif.org',
+    isExternal: true,
+  },
+  {
+    version: '2.0',
     href: 'https://v2.docs.ohif.org',
     isExternal: true,
   },
   {
-    version: '1.0-deprecated',
+    version: '1.0',
     href: 'https://v1.docs.ohif.org',
     isExternal: true,
   },
@@ -136,10 +141,11 @@ module.exports = {
         // respectPrefersColorScheme: true,
       },
       announcementBar: {
-        id: 'healthimaging',
+        id: 'cornerstone20_ohif_anniversary',
         content:
-          '🎉 OHIF 3.8 has landed! Explore 4D and volume rendering, enhanced layout menus, streamlined visualization controls, workflow steps, and more. You can find the release notes by following this <a target="_blank" rel="noopener noreferrer" href="https://ohif.org/release-notes/3p8/">Link!</a> 🌟',
+          '🎉 Celebrating OHIF’s 10-Year Anniversary with Cornerstone 2.0! Explore enhanced segmentation, new video & microscopy viewports, UI/UX upgrades, and blazing fast prefetching. Dive into the release notes <a target="_blank" rel="noopener noreferrer" href="https://ohif.org/release-notes/3p9/">here</a>! 🚀',
       },
+
       prism: {
         theme: require('prism-react-renderer').themes.github,
         darkTheme: require('prism-react-renderer').themes.dracula,

platform/docs/package.json

@@ -41,16 +41,16 @@
     ]
   },
   "dependencies": {
-    "@docusaurus/core": "3.6.0",
-    "@docusaurus/faster": "3.6.0",
-    "@docusaurus/plugin-client-redirects": "3.6.0",
-    "@docusaurus/plugin-google-gtag": "3.6.0",
-    "@docusaurus/plugin-ideal-image": "3.6.0",
-    "@docusaurus/plugin-pwa": "3.6.0",
-    "@docusaurus/preset-classic": "3.6.0",
-    "@docusaurus/remark-plugin-npm2yarn": "3.6.0",
-    "@docusaurus/theme-classic": "3.6.0",
-    "@docusaurus/theme-live-codeblock": "3.6.0",
+    "@docusaurus/core": "3.6.1",
+    "@docusaurus/faster": "3.6.1",
+    "@docusaurus/plugin-client-redirects": "3.6.1",
+    "@docusaurus/plugin-google-gtag": "3.6.1",
+    "@docusaurus/plugin-ideal-image": "3.6.1",
+    "@docusaurus/plugin-pwa": "3.6.1",
+    "@docusaurus/preset-classic": "3.6.1",
+    "@docusaurus/remark-plugin-npm2yarn": "3.6.1",
+    "@docusaurus/theme-classic": "3.6.1",
+    "@docusaurus/theme-live-codeblock": "3.6.1",
     "@mdx-js/react": "3.0.1",
     "@radix-ui/react-accordion": "^1.2.0",
     "@radix-ui/react-checkbox": "^1.1.1",

platform/docs/versioned_docs/version-3.8/deployment/authorization.md

@@ -1,67 +0,0 @@
----
-sidebar_position: 6
-sidebar_label: Authorization
----
-
-# Authorization
-The OHIF Viewer can be configured to work with authorization servers that support one or more of the OpenID-Connect authorization flows. The Viewer finds it's OpenID-Connect settings on the oidc configuration key. You can set these values in your configuration files. For instance you can take a look at our
-`google.js` configuration file.
-
-
-```js
-oidc: [
-    {
-      // ~ REQUIRED
-      // Authorization Server URL
-      authority: 'https://accounts.google.com',
-      client_id:
-        '723928408739-k9k9r3i44j32rhu69vlnibipmmk9i57p.apps.googleusercontent.com',
-      redirect_uri: '/callback',
-      response_type: 'id_token token',
-      scope:
-        'email profile openid https://www.googleapis.com/auth/cloudplatformprojects.readonly https://www.googleapis.com/auth/cloud-healthcare', // email profile openid
-      // ~ OPTIONAL
-      post_logout_redirect_uri: '/logout-redirect.html',
-      revoke_uri: 'https://accounts.google.com/o/oauth2/revoke?token=',
-      automaticSilentRenew: true,
-      revokeAccessTokenOnSignout: true,
-    },
-  ],
-```
-
-You need to provide the following information:
-- authority: The URL of the authorization server.
-- client_id: The client id of your application (provided by the authorization server).
-- redirect_uri: The callback URL of your application.
-- response_type: The response type of the authorization flow (e.g. id_token token, [learn more about different flows](https://darutk.medium.com/diagrams-of-all-the-openid-connect-flows-6968e3990660)).
-- scope: The scopes that your application needs to access
-- post_logout_redirect_uri: The URL that the user will be redirected to after logout.
-- revoke_uri: The URL that the user will be redirected to after logout.
-- automaticSilentRenew: If true, the user will be automatically logged in after the token expires.
-- revokeAccessTokenOnSignout: If true, the access token will be revoked on logout.
-
-
-
-## How it works
-The Viewer uses the `userAuthenticationService` to set the OpenID-Connect settings. The `userAuthenticationService` is a singleton service that is responsible for authentication and authorization. It is initialized by the app and you can grab it
-from the `servicesManager`
-
-```js
-const userAuthenticationService = servicesManager.services.userAuthenticationService;
-```
-
-Then the userAuthenticationService will inject the token as Authorization header in the requests that are sent to the server (both metadata
-and pixelData).
-
-
-## Token based authentication
-Sometimes (although not recommended), some servers like to send the token
-in the query string. In this case, the viewer will automatically grab the token from the query string
-and add it to the userAuthenticationService and remove it from the query string (to prevent it from being logged in the console
-in future requests).
-
-and example would be
-
-```js
-http://localhost:3000/viewer?StudyInstanceUIDs=1.2.3.4.5.6.6.7&token=e123125jsdfahsdf
-```

platform/docs/versioned_docs/version-3.8/deployment/user-account-control.md

@@ -1,292 +0,0 @@
----
-sidebar_position: 11
----
-# User Account Control
-
-> DISCLAIMER! We make no claims or guarantees of this approach's security. If in
-> doubt, enlist the help of an expert and conduct proper audits.
-
-Making a viewer and its medical imaging data accessible on the open web can
-provide a lot of benefits, but requires additional security to make sure
-sensitive information can only be viewed by authorized individuals. Most image
-archives are equipped with basic security measures, but they are not
-robust/secure enough for the open web.
-
-This guide covers one of many potential production setups that secure our
-sensitive data.
-
-## Overview
-
-This guide builds on top of our
-[Nginx + Image Archive guide](/deployment/recipes/nginx--image-archive.md),
-wherein we used a [`reverse proxy`](https://en.wikipedia.org/wiki/Reverse_proxy)
-to retrieve resources from our image archive (Orthanc).
-
-To add support for "User Account Control" we introduce
-[Keycloak](https://www.keycloak.org/about.html). Keycloak is an open source
-Identity and Access Management solution that makes it easy to secure
-applications and services with little to no code. We improve upon our
-`reverse proxy` setup by integrating Keycloak and Nginx to create an
-`authenticating reverse proxy`.
-
-> An authenticating reverse proxy is a reverse proxy that only retrieves the
-> resources on behalf of a client if the client has been authenticated. If a
-> client is not authenticated they can be redirected to a login page.
-
-This setup allows us to create a setup similar to the one pictured below:
-
-![userControlFlow](../assets/img/user-access-control-request-flow.png)
-
-
-
-- All web requests are routed through `nginx` on our `OpenResty` image
-- `/pacs` is a reverse proxy for `orthanc`'s `DICOM Web` endpoints
-  - Requires valid `Authorization: Bearer <token>` header
-- `/pacs-admin` is a reverse proxy for `orthanc`'s Web Admin
-- `/auth` is a reverse proxy for `keycloak`
-- All static resources for OHIF Viewer are unprotected and accessible. We have
-  application logic that will redirect unauthenticated users to the appropriate
-  `keycloak` login screen.
-
-## Getting Started
-
-### Requirements
-
-- Docker
-  - [Docker for Mac](https://docs.docker.com/docker-for-mac/)
-  - [Docker for Windows](https://docs.docker.com/docker-for-windows/)
-
-_Not sure if you have `docker` installed already? Try running `docker --version`
-in command prompt or terminal_
-
-### Setup
-
-_Spin Things Up_
-
-- Navigate to `<project-root>platform\app\.recipes\OpenResty-Orthanc-Keycloak` in your shell
-- Run `docker-compose up`
-
-_Create Your First User_
-
-- Navigate to: `http://127.0.0.1/auth/admin`
-- Sign in with: `admin`/`password`
-- From the top left dropdown, select the `Ohif` realm
-- From the left sidebar, under `Manage`, select `Users`
-- Click `Add User`
-  - Username: `test`
-  - Email Verified: `ON`
-  - Click `Save`
-- Click the `Credentials` Tab
-  - New Password: `test`
-  - Password Confirmation: `test`
-  - Temporary: `OFF`
-  - Click: `Reset Password`
-- From the top right dropdown, select `Admin`, then `Sign Out`
-
-_Sign In_
-
-- Navigate to `http://127.0.0.1/`
-- Username: `test`, Password: `test`
-- Click `Log In`
-
-_Upload Your First Study_
-
-- Navigate to `http://127.0.0.1/pacs-admin`
-- If you're not already logged in, use `test`/`test`
-- From the top right, select "Upload"
-- Click "Select files to upload..." (DICOM)
-- Click "Start the upload"
-- Navigate back to `http://127.0.0.1/` to view your studies in the Study List
-
-### Troubleshooting
-
-_Exit code 137_
-
-This means Docker ran out of memory. Open Docker Desktop, go to the `advanced`
-tab, and increase the amount of Memory available.
-
-_Cannot create container for service X_
-
-Use this one with caution: `docker system prune`
-
-_X is already running_
-
-Stop running all containers:
-
-- Win: `docker ps -a -q | ForEach { docker stop $_ }`
-- Linux: `docker stop $(docker ps -a -q)`
-
-### Configuration
-
-After verifying that everything runs with default configuration values, you will
-likely want to update:
-
-- The domain: `http://127.0.0.1`
-- Set secure, non-default passwords
-- Regenerate Keycloak Client Secrets
-
-#### OHIF Viewer
-
-The OHIF Viewer's configuration is imported from a static `.js` file. The
-configuration we use is set to a specific file when we build the viewer, and
-determined by the env variable: `APP_CONFIG`. You can see where we set its value
-in the `dockerfile` for this solution:
-
-`ENV APP_CONFIG=config/docker_openresty-orthanc-keycloak.js`
-
-You can find the configuration we're using here:
-`/public/config/docker_openresty-orthanc-keycloak.js`
-
-To rebuild the `webapp` image created by our `dockerfile` after updating the
-Viewer's configuration, you can run:
-
-- `docker-compose build` OR
-- `docker-compose up --build`
-
-#### Other
-
-All other files are found in: `/docker/OpenResty-Orthanc-Keycloak/`
-
-| Service           | Configuration                                    | Docs                                        |
-| ----------------- | ------------------------------------------------ | ------------------------------------------- |
-| OHIF Viewer       | [dockerfile][dockerfile] / [config.js][config]   | You're reading them now!                    |
-| OpenResty (Nginx) | [`/nginx.conf`][config-nginx]                    | [lua-resty-openidc][lua-resty-openidc-docs] |
-| Orthanc           | [`/orthanc.json`][config-orthanc]                | [Here][orthanc-docs]                        |
-| Keycloak          | [`/ohif-keycloak-realm.json`][config-keycloak]\* |                                             |
-
-\* These are the seed values for Keycloak. They can be manually updated at
-`http://127.0.0.1/auth/admin`
-
-#### Keycloak Themeing
-
-The `Login` screen for the `ohif-viewer` client is using a Custom Keycloak
-theme. You can find the source files for it in
-`/docker/OpenResty-Orthanc-Keycloak/volumes/keycloak-themes/`. You can see how
-we add it to Keycloak in the `docker-compose` file, and you can read up on how
-to leverage custom themes in
-[Keycloak's own docs](https://www.keycloak.org/docs/latest/server_development/index.html#_themes).
-
-| Default Theme                                                          | OHIF Theme                                                       |
-| ---------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| ![Keycloak Default Theme](../assets/img/keycloak-default-theme.png) | ![Keycloak OHIF Theme](../assets/img/keycloak-ohif-theme.png) |
-
-## Next Steps
-
-### Deploying to Production
-
-While these configuration and docker-compose files model an environment suitable
-for production, they are not easy to deploy "as is". You can either:
-
-- Manually recreate this environment and deploy built application files **OR**
-- Deploy to a cloud kubernetes provider like
-  [Digital Ocean](https://www.digitalocean.com/products/kubernetes/) **OR**
-  - [See a full list of cloud providers here](https://landscape.cncf.io/category=cloud&format=card-mode&grouping=category)
-- Find and follow your preferred provider's guide on setting up
-  [swarms and stacks](https://docs.docker.com/get-started/)
-
-### Adding SSL
-
-Adding SSL registration and renewal for your domain with Let's Encrypt that
-terminates at Nginx is an incredibly important step toward securing your data.
-Here are some resources, specific to this setup, that may be helpful:
-
-- [lua-resty-auto-ssl](https://github.com/GUI/lua-resty-auto-ssl)
-- [Let's Encrypt + Nginx](https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/)
-
-While we terminate SSL at Nginx, it may be worth using self signed certificates
-for communication between services.
-
-- [SSL Termination for TCP Upstream Servers](https://docs.nginx.com/nginx/admin-guide/security-controls/terminating-ssl-tcp/)
-
-### Use PostgresSQL w/ Orthanc
-
-Orthanc can handle a large amount of data and requests, but if you find that
-requests start to slow as you add more and more studies, you may want to
-configure your Orthanc instance to use PostgresSQL. Instructions on how to do
-that can be found in the
-[`Orthanc Server Book`](http://book.orthanc-server.com/users/docker.html), under
-"PostgreSQL and Orthanc inside Docker"
-
-### Improving This Guide
-
-Here are some improvements this guide would benefit from, and that we would be
-more than happy to accept Pull Requests for:
-
-- SSL Support
-- Complete configuration with `.env` file (or something similar)
-- Keycloak Theme improvements
-- Any security issues
-- One-click deploy to a cloud provider
-
-## Resources
-
-### Misc. Helpful Commands
-
-_Check if `nginx.conf` is valid:_
-
-```bash
-docker run --rm -t -a stdout --name my-openresty -v $PWD/config/:/usr/local/openresty/nginx/conf/:ro openresty/openresty:alpine-fat openresty -c /usr/local/openresty/nginx/conf/nginx.conf -t
-```
-
-_Interact w/ running container:_
-
-`docker exec -it CONTAINER_NAME bash`
-
-_List running containers:_
-
-`docker ps`
-
-_Clear Keycloak DB so you can re-seed values:_
-
-- `docker volume prune` OR
-- `docker volume ls` and `docker volume rm VOLUME_NAME VOLUME_NAME`
-
-### Referenced Articles
-
-The inspiration for our setup was driven largely by these articles:
-
-- [Securing Nginx with Keycloak](https://edhull.co.uk/blog/2018-06-06/keycloak-nginx)
-- [Authenticating Reverse Proxy with Keycloak](https://eclipsesource.com/blogs/2018/01/11/authenticating-reverse-proxy-with-keycloak/)
-- [Securing APIs with Kong and Keycloak](https://www.jerney.io/secure-apis-kong-keycloak-1/)
-
-For more documentation on the software we've chosen to use, you may find the
-following resources helpful:
-
-- [Orthanc for Docker](http://book.orthanc-server.com/users/docker.html)
-- [OpenResty Guide](http://www.staticshin.com/programming/definitely-an-open-resty-guide/)
-- [Lua Ngx API](https://openresty-reference.readthedocs.io/en/latest/Lua_Nginx_API/)
-- [Auth0: Picking a Grant Type](https://auth0.com/docs/api-auth/which-oauth-flow-to-use)
-
-We chose to use a generic OpenID Connect library on the client, but it's worth
-noting that Keycloak comes packaged with its own:
-
-- [oidc-client-js](https://github.com/IdentityModel/oidc-client-js/wiki)
-- [Keycloak JavaScript Adapter](https://www.keycloak.org/docs/latest/securing_apps/index.html#_javascript_adapter)
-
-If you're not already drowning in links, here are some good security resources
-for OAuth:
-
-- [Diagrams of OpenID Connect Flows](https://medium.com/@darutk/diagrams-of-all-the-openid-connect-flows-6968e3990660)
-- [KeyCloak: OpenID Connect Flows](https://www.keycloak.org/docs/latest/securing_apps/index.html#authorization-code)
-
-For a different take on this setup, check out the repositories our community
-members put together:
-
-- [mjstealey/ohif-orthanc-dimse-docker](https://github.com/mjstealey/ohif-orthanc-dimse-docker)
-- [trypag/ohif-orthanc-postgres-docker](https://github.com/trypag/ohif-orthanc-postgres-docker)
-
-<!--
-  Links
-  -->
-
-<!-- prettier-ignore-start -->
-<!-- DOCS -->
-[orthanc-docs]: http://book.orthanc-server.com/users/configuration.html#configuration
-[lua-resty-openidc-docs]: https://github.com/zmartzone/lua-resty-openidc
-<!-- SRC -->
-[config]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/src/config.js
-[dockerfile]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/dockerfile
-[config-nginx]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/config/nginx.conf
-[config-orthanc]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/config/orthanc.json
-[config-keycloak]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/config/ohif-keycloak-realm.json
-<!-- prettier-ignore-end -->

platform/docs/versioned_docs/version-3.8/faq.md

@@ -1,302 +0,0 @@
----
-sidebar_position: 8
-sidebar_label: FAQ
----
-
-
-- [General FAQ](#general-faq)
-  - [How do I report a bug?](#how-do-i-report-a-bug)
-  - [How can I request a new feature?](#how-can-i-request-a-new-feature)
-  - [Who should I contact about Academic Collaborations?](#who-should-i-contact-about-academic-collaborations)
-  - [Does OHIF offer support?](#does-ohif-offer-support)
-  - [Does The OHIF Viewer have 510(k) Clearance from the U.S. F.D.A or CE Marking from the European Commission?](#does-the-ohif-viewer-have-510k-clearance-from-the-us-fda-or-ce-marking-from-the-european-commission)
-  - [Is there a DICOM Conformance Statement for the OHIF Viewer?](#is-there-a-dicom-conformance-statement-for-the-ohif-viewer)
-  - [Is The OHIF Viewer HIPAA Compliant?](#is-the-ohif-viewer-hipaa-compliant)
-  - [Could you provide me with a particular study from the OHIF Viewer Demo?](#could-you-provide-me-with-a-particular-study-from-the-ohif-viewer-demo)
-- [Technical FAQ](#technical-faq)
-  - [Why do I keep seeing a Cross Origin Isolation warning](#why-do-i-keep-seeing-a-cross-origin-isolation-warning)
-  - [What if my setup does not support the Shared Array Buffers API?](#what-if-my-setup-does-not-support-the-shared-array-buffers-api)
-  - [Viewer opens but does not show any thumbnails](#viewer-opens-but-does-not-show-any-thumbnails)
-  - [What are the list of required metadata for the OHIF Viewer to work?](#what-are-the-list-of-required-metadata-for-the-ohif-viewer-to-work)
-    - [Mandatory](#mandatory)
-    - [Optional](#optional)
-  - [How do I handle large volumes for MPR and Volume Rendering](#how-do-i-handle-large-volumes-for-mpr-and-volume-rendering)
-    - [`useNorm16Texture`](#usenorm16texture)
-    - [`preferSizeOverAccuracy`](#prefersizeoveraccuracy)
-
-
-# General FAQ
-
-
-## How do I report a bug?
-
-Navigate to our [GitHub Repository][new-issue], and submit a new bug report.
-Follow the steps outlined in the [Bug Report Template][bug-report-template].
-
-## How can I request a new feature?
-
-At the moment we are in the process of defining our roadmap and will do our best
-to communicate this to the community. If your requested feature is on the
-roadmap, then it will most likely be built at some point. If it is not, you are
-welcome to build it yourself and [contribute it](development/contributing.md).
-If you have resources and would like to fund the development of a feature,
-please [contact us](https://ohif.org/get-support).
-
-
-## Who should I contact about Academic Collaborations?
-
-[Gordon J. Harris](https://www.dfhcc.harvard.edu/insider/member-detail/member/gordon-j-harris-phd/)
-at Massachusetts General Hospital is the primary contact for any academic
-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 support?
-
-yes, you can contact us for more information [here](https://ohif.org/get-support)
-
-
-## 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?
-
-**NO.** The OHIF Viewer is **NOT** F.D.A. cleared or CE Marked. It is the users'
-responsibility to ensure compliance with applicable rules and regulations. The
-[License](https://github.com/OHIF/Viewers/blob/master/LICENSE) for the OHIF
-Platform does not prevent your company or group from seeking F.D.A. clearance
-for a product built using the platform.
-
-If you have gone this route (or are going there), please let us know because we
-would be interested to hear about your experience.
-
-## Is there a DICOM Conformance Statement for the OHIF Viewer?
-
-Yes, check it here [DICOM Conformance Statement](https://docs.google.com/document/d/1hbDlUApX4svX33gAUGxGfD7fXXZNaBsX0hSePbc-hNA/edit?usp=sharing)
-
-## Is The OHIF Viewer [HIPAA][hipaa-def] Compliant?
-
-**NO.** The OHIF Viewer **DOES NOT** fulfill all of the criteria to become HIPAA
-Compliant. It is the users' responsibility to ensure compliance with applicable
-rules and regulations.
-
-## Could you provide me with a particular study from the OHIF Viewer Demo?
-
-You can check out the studies that we have put in this [Dropbox link](https://www.dropbox.com/scl/fo/66xidsx13pn0zf3b9cbfq/ADaCgn7aT29WMlnTdT_WRXM?rlkey=rratvx6g4kfxnswjdbupewjye&dl=0)
-
-# Technical FAQ
-
-
-
-## Why do I keep seeing a Cross Origin Isolation warning
-If you encounter a warning while running OHIF indicating that your application is not cross-origin isolated, it implies that volume rendering, such as MPR, will not function properly since they depend on Shared Array Buffers. To resolve this issue, we recommend referring to our comprehensive guide on Cross Origin Isolation available at [our dedicated cors page](./deployment/cors.md).
-
-## What if my setup does not support the Shared Array Buffers API?
-You can simply disable that by adding the `useSharedArrayBuffer: 'FALSE'` (notice the string FALSE), and the volumes will only use a regular
-array buffer which is a bit slower but will work on all browsers.
-
-
-## Viewer opens but does not show any thumbnails
-
-Thumbnails may not appear in your DICOMWeb application for various reasons. This guide focuses on one primary scenario, which is you are using
-the `supportsWildcard: true` in your configuration file while your sever does not support it.
-One
-
-For instance for the following filtering in the worklist tab we send this request
-
-![](assets/img/filtering-worklist.png)
-
-`https://d33do7qe4w26qo.cloudfront.net/dicomweb/studies?PatientName=*Head*&limit=101&offset=0&fuzzymatching=false&includefield=00081030%2C00080060`
-
-Which our server can respond properly. If your server does not support this type of filtering, you can disable it by setting `supportsWildcard: false` in your configuration file,
-or edit your server code to support it for instance something like
-
-```js
-Pseudocode:
-For each filter in filters:
-    if filter.value contains "*":
-        Convert "*" to SQL LIKE wildcard ("%")
-        Add "metadataField LIKE ?" to query
-    else:
-        Add "metadataField = ?" to query
-```
-
-
-
-## What are the list of required metadata for the OHIF Viewer to work?
-
-
-### Mandatory
-
-**All Modalities**
-
-- `StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`: Unique identifiers for the study, series, and object.
-- `PhotometricInterpretation`: Describes the color space of the image.
-- `Rows`, `Columns`: Image dimensions.
-- `PixelRepresentation`: Indicates how pixel data should be interpreted.
-- `Modality`: Type of modality (e.g., CT, MR, etc.).
-- `PixelSpacing`: Spacing between pixels.
-- `BitsAllocated`: Number of bits allocated for each pixel sample.
-- `SOPClassUID`: Specifies the DICOM service class of the object (though you might be able to render without it for most regular images datasets, but it is pretty normal to have it)
-
-**Rendering**
-
-You need to have the following tags for the viewer to render the image properly, otherwise you should
-use the windowing tools to adjust the image to your liking:
-
-- `RescaleIntercept`, `RescaleSlope`: Values used for rescaling pixel values for visualization.
-- `WindowCenter`, `WindowWidth`: Windowing parameters for display.
-
-**Some Datasets**
-
-- `InstanceNumber`: Useful for sorting instances (without it the instances might be out of order)
-
-**For MPR (Multi-Planar Reformatting) rendering and tools**
-
-- `ImagePositionPatient`, `ImageOrientationPatient`: Position and orientation of the image in the patient.
-
-**SEG (Segmentation)**
-
-- `FrameOfReferenceUID` for handling segmentation layers.
-- sequences
-  - `ReferencedSeriesSequence`
-  - `SharedFunctionalGroupsSequence`
-  - `PerFrameFunctionalGroupsSequence`
-
-**RTSTRUCT (Radiotherapy Structure)**
-
-- `FrameOfReferenceUID` for handling segmentation layers.
-- sequences
-  - `ROIContourSequence`
-  - `StructureSetROISequence`
-  - `ReferencedFrameOfReferenceSequence`
-
-**US (Ultrasound)**
-
-- `NumberOfFrames`: Number of frames in a multi-frame image.
-- `SequenceOfUltrasoundRegions`: For measurements.
-- `FrameTime`: Time between frames if specified.
-
-**SR (Structured Reporting)**
-
-- Various sequences for encoding the report content and template.
-  - `ConceptNameCodeSequence`
-  - `ContentSequence`
-  - `ContentTemplateSequence`
-  - `CurrentRequestedProcedureEvidenceSequence`
-  - `ContentTemplateSequence`
-  - `CodingSchemeIdentificationSequence`
-
-**PT with SUV Correction (Positron Tomography Standardized Uptake Value)**
-
-- Sequences and tags related to radiopharmaceuticals, units, corrections, and timing.
-  - `RadiopharmaceuticalInformationSequence`
-  - `SeriesDate`
-  - `SeriesTime`
-  - `CorrectedImage`
-  - `Units`
-  - `DecayCorrection`
-  - `AcquisitionDate`
-  - `AcquisitionTime`
-  - `PatientWeight`
-
-**PDF**
-
-- `EncapsulatedDocument`: Contains the PDF document.
-
-**Video**
-
-- `NumberOfFrames`: Video frame count .
-
-
-### Optional
-There are various other optional tags that will add to the viewer experience, but are not required for basic functionality. These include:
-Patient Information, Study Information, Series Information, Instance Information, and Frame Information.
-
-
-## How do I handle large volumes for MPR and Volume Rendering
-
-Currently there are two ways to handle large volumes for MPR and Volume Rendering if that does not
-fit in the memory of the client machine.
-
-### `useNorm16Texture`
-
-WebGL officially supports only 8-bit and 32-bit data types. For most images, 8 bits are not enough, and 32 bits are too much. However, we have to use the 32-bit data type for volume rendering and MPR, which results in suboptimal memory consumption for the application.
-
-Through [EXT_texture_norm16](https://registry.khronos.org/webgl/extensions/EXT_texture_norm16/) , WebGL can support 16 bit data type which is ideal
-for most images. You can look into the [webgl report](https://webglreport.com/?v=2) to check if you have that extension enabled.
-
-![](assets/img/webgl-report-norm16.png)
-
-
-This is a flag that you can set in your [configuration file](./configuration/configurationFiles.md) to force usage of 16 bit data type for the volume rendering and MPR. This will reduce the memory usage by half.
-
-
-For instance for a large pt/ct study
-
-![](assets/img/large-pt-ct.png)
-
-Before (without the flag) the app shows 399 MB of memory usage
-
-![](assets/img/memory-profiling-regular.png)
-
-
-After (with flag, running locally) the app shows 249 MB of memory usage
-
-
-![](assets/img/webgl-int16.png)
-
-:::note
-Using the 16 bit texture (if supported) will not have any effect in the rendering what so ever, and pixelData
-would be exactly shown as it is. For datasets that cannot be represented with 16 bit data type, the flag will be ignored
-and the 32 bit data type will be used.
-
-
-Read more about these discussions in our PRs
-- https://github.com/Kitware/vtk-js/pull/2058
-:::
-
-
-:::warning
-Although the support for 16 bit data type is available in WebGL, in some settings (e.g., Intel-based Macos) there seems
-to be still some issues with it. You can read and track bugs below.
-
-- https://bugs.chromium.org/p/chromium/issues/detail?id=1246379
-- https://bugs.chromium.org/p/chromium/issues/detail?id=1408247
-:::
-
-### `preferSizeOverAccuracy`
-
-This is another flag that you can set in your [configuration file](./configuration/configurationFiles.md) to force the usage of the `half_float` data type for volume rendering and MPR. The main reason to choose this option over `useNorm16Texture` is its broader support across hardware and browsers. However, it is less accurate than the 16-bit data type and may lead to some rendering artifacts.
-
-```js
-Integers between 0 and 2048 can be exactly represented (and also between −2048 and 0)
-Integers between 2048 and 4096 round to a multiple of 2 (even number)
-Integers between 4096 and 8192 round to a multiple of 4
-Integers between 8192 and 16384 round to a multiple of 8
-Integers between 16384 and 32768 round to a multiple of 16
-Integers between 32768 and 65519 round to a multiple of 32
-```
-
-As you see in the ranges above 2048 there will be inaccuracies in the rendering.
-
-Memory snapshot after enabling `preferSizeOverAccuracy` for the same study as above
-
-![](assets/img/preferSizeOverAccuracy.png)
-
-
-
-
-<!--
-  Links
-  -->
-[general]: #general
-[technical]: #technical
-[report-bug]: #how-do-i-report-a-bug
-[new-feature]: #how-can-i-request-a-new-feature
-[commercial-support]: #does-ohif-offer-commercial-support
-[academic]: #who-should-i-contact-about-academic-collaborations
-[fda-clearance]: #does-the-ohif-viewer-have-510k-clearance-from-the-us-fda-or-ce-marking-from-the-european-commission
-[hipaa]: #is-the-ohif-viewer-hipaa-compliant
-[501k-clearance]: https://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/HowtoMarketYourDevice/PremarketSubmissions/PremarketNotification510k/
-[ce-marking]: https://ec.europa.eu/growth/single-market/ce-marking_en
-[hipaa-def]: https://en.wikipedia.org/wiki/Health_Insurance_Portability_and_Accountability_Act
-[new-issue]: https://github.com/OHIF/Viewers/issues/new/choose
-[bug-report-template]: https://github.com/OHIF/Viewers/issues/new?assignees=&labels=Bug+Report+%3Abug%3A&template=---bug-report.md&title=

platform/docs/versioned_docs/version-3.8/platform/services/data/StateSyncService.md

@@ -1,93 +0,0 @@
----
-sidebar_position: 8
-sidebar_label: State Sync
----
-
-# State Sync
-
-## Overview
-
-Applications often need a way to save and restore state, allowing users to continue their work seamlessly across sessions or after restarts. This is essential for keeping user preferences, preserving app context, and providing a consistent experience. For example, hanging protocol layouts, and window level improves user interactions, allowing for smooth navigation between protocols and restoring layouts upon returning. This document explains how to manage and sync state in the application using Zustand stores, providing built-in state stores and tools for extensions to create and manage their own.
-
-
-## Built-in Zustand Stores
-
-The following stores are available for managing different aspects of application state:
-
-* **`useLutPresentationStore`**: Manages LUT (window level) presentation state.  Key features:
-    * `setLutPresentation(key, value)`: Sets a LUT presentation for a given `key`.
-    * `clearLutPresentationStore()`: Clears all stored LUT presentations.
-    * `getPresentationId(id, options)`: Retrieves the presentation ID based on viewport and display set information.
-
-* **`usePositionPresentationStore`**: Manages viewport position (camera, initial image) state. Key features:
-    * `setPositionPresentation(key, value)`: Sets a position presentation for a given `key`.
-    * `clearPositionPresentationStore()`: Clears all stored position presentations.
-    * `getPresentationId(id, options)`: Retrieves the presentation ID based on viewport and display set information.
-    * `getPositionPresentationId(viewport, viewports?, isUpdatingSameViewport?)`:  Gets the position presentation ID.
-
-* **`useSegmentationPresentationStore`**: Manages segmentation presentation state. Key features:
-    * `setSegmentationPresentation(presentationId, value)`: Sets a segmentation presentation for a given `presentationId`.
-    * `clearSegmentationPresentationStore()`: Clears all stored segmentation presentations.
-    * `getPresentationId(id, options)`: Retrieves the presentation ID based on viewport, display set, and services manager information.
-    * `addSegmentationPresentation(presentationId, segmentationPresentation, { servicesManager })`: Adds a new segmentation presentation.
-    * `getSegmentationPresentationId({ viewport, servicesManager })`: Retrieves the current segmentation presentation ID.
-
-* **`useSynchronizersStore`**: Manages viewport synchronization state. Key features:
-    * `setSynchronizers(viewportId, synchronizers)`: Sets synchronizers for a specific viewport.
-    * `clearSynchronizersStore()`: Clears the entire synchronizers store.
-
-
-## Creating Custom State Stores with Zustand
-
-Extensions can create their own Zustand stores to manage custom state.  This approach leverages Zustand's simplicity and performance.
-
-```javascript
-import { create } from 'zustand';
-import { devtools } from 'zustand/middleware';
-
-// Define your state shape
-interface MyCustomState {
-  count: number;
-  increment: () => void;
-  reset: () => void;
-}
-
-// Create your store
-const useMyCustomStore = create<MyCustomState>()(
-  devtools((set) => ({
-    count: 0,
-    increment: () => set((state) => ({ count: state.count + 1 })),
-    reset: () => set({ count: 0 }),
-  }), { name: 'MyCustomStore' }) // Use devtools for debugging
-);
-
-// Use the store in your component
-function MyComponent() {
-  const { count, increment, reset } = useMyCustomStore();
-
-  return (
-    <div>
-      <p>Count: {count}</p>
-      <button onClick={increment}>Increment</button>
-      <button onClick={reset}>Reset</button>
-    </div>
-  );
-}
-```
-
-### Best Practices
-
-* **Naming:** Use a clear and descriptive name for your store, prefixed with `use`, e.g., `useMyCustomStore`.
-* **Typing:** Define the state interface using TypeScript for better type safety and code maintainability.
-* **Devtools:** Use the `devtools` middleware in development to easily inspect and debug your store's state changes.
-* **State Updates:** Use the `set` function to update the state, ensuring immutability by returning a new state object or using the callback form to access the previous state.
-
-
-
-## Migration from Legacy State Sync Service
-
-Existing extensions using the legacy `stateSyncService` should migrate to using individual Zustand stores.  This involves:
-
-1.  Creating a new Zustand store for each piece of state previously managed by `stateSyncService`.
-2.  Updating the extension code to use the new store instead of `stateSyncService`.
-3.  Removing the legacy `stateSyncService` registration code.