From 4e185e4b21b1829300ded98a3f254a39c1bba71f Mon Sep 17 00:00:00 2001 From: Alireza Date: Thu, 1 May 2025 18:13:21 -0400 Subject: [PATCH] docs: add llm txt (#5009) --- .../docs/configuration/configurationFiles.md | 2 + .../dataSources/configuration-ui.md | 2 + .../configuration/dataSources/dicom-json.md | 2 + .../dataSources/dicom-web-proxy.md | 2 + .../configuration/dataSources/dicom-web.md | 2 + .../configuration/dataSources/introduction.md | 2 + .../configuration/dataSources/static-files.md | 2 + platform/docs/docs/configuration/tours.md | 2 + platform/docs/docs/configuration/url.md | 2 + platform/docs/docs/conformance.md | 1 + .../docs/docs/deployment/authorization.md | 2 + platform/docs/docs/deployment/azure.md | 2 + .../docs/deployment/build-for-production.md | 2 + platform/docs/docs/deployment/cors.md | 2 + .../docs/docs/deployment/custom-url-access.md | 1 + .../docs/docs/deployment/docker/docker.md | 2 + platform/docs/docs/deployment/docker/ssl.md | 3 +- .../deployment/google-cloud-healthcare.md | 2 + platform/docs/docs/deployment/iframe.md | 2 + platform/docs/docs/deployment/index.md | 2 + .../docs/deployment/nginx--image-archive.md | 2 + .../docs/docs/deployment/static-assets.md | 2 + .../docs/deployment/user-account-control.md | 2 + .../docs/development/android-ios-debugging.md | 2 + .../docs/docs/development/architecture.md | 2 + .../development/continuous-integration.md | 2 + .../docs/docs/development/contributing.md | 2 + .../docs/docs/development/getting-started.md | 2 + platform/docs/docs/development/link.md | 2 + platform/docs/docs/development/ohif-cli.md | 2 + platform/docs/docs/development/our-process.md | 2 + .../docs/development/playwright-testing.md | 2 + platform/docs/docs/development/testing.md | 2 + platform/docs/docs/development/types.md | 2 + .../docs/docs/development/video-tutorials.md | 2 + platform/docs/docs/development/webWorkers.md | 2 + platform/docs/docs/faq/general.md | 2 + platform/docs/docs/faq/index.md | 2 + platform/docs/docs/faq/technical.md | 6 + .../migration-guide/3p8-to-3p9/0-general.md | 1 + .../1-segmentation/1-Architecture.md | 1 + .../2-segmentationService-basic.md | 1 + .../3-segmentationserice-representation.md | 1 + .../4-segmentationserice-creation.md | 3 +- .../4-segmentationserice-modification.md | 1 + .../5-segmentationserice-style.md | 1 + .../6-segmentationserice-other.md | 1 + .../3p8-to-3p9/1-segmentation/index.md | 1 + .../migration-guide/3p8-to-3p9/2-Renamings.md | 1 + .../3p8-to-3p9/3-DataSources.md | 1 + .../3p8-to-3p9/4-Measurements.md | 1 + .../3p8-to-3p9/4-ViewportActionCorner.md | 1 + .../3p8-to-3p9/5-StateSyncService.md | 1 + .../migration-guide/3p8-to-3p9/6-RTSTRUCT.md | 1 + .../docs/migration-guide/3p8-to-3p9/7-UI.md | 1 + .../3p8-to-3p9/8-Refactorings.md | 1 + .../migration-guide/3p8-to-3p9/9-other.md | 1 + .../docs/migration-guide/3p8-to-3p9/index.md | 1 + .../3p9-to-3p10/1-General/commands.md | 1 + .../3p9-to-3p10/1-General/general-m.md | 1 + .../3p9-to-3p10/1-General/hotkeys.md | 1 + .../3p9-to-3p10/1-General/routerBaseName.md | 1 + .../2-CustomizationService/index.md | 1 + .../3p9-to-3p10/3-UI/1-Introduction.md | 1 + .../3-UI/10-Migration-3p10-Tests.md | 1 + .../3p9-to-3p10/3-UI/1a-Colors.md | 1 + .../3-UI/2-Migration-3p10-Icons.md | 1 + .../3-UI/2a-Migration-3p10-Button.md | 1 + .../3-UI/3-Migration-3p10-Input.md | 1 + .../3-UI/4-Migration-3p10-Tooltip.md | 1 + .../3-UI/4a-Migration-3p10-Select.md | 3 +- .../3-UI/4a-Migration-3p10-Switch.md | 1 + .../3-UI/5-Migration-3p10-Toolbar.md | 1 + .../6-Migration-3p10-SegmentationTable.md | 1 + .../3-UI/7-Migration-3p10-Tours.md | 1 + .../3-UI/8-Migration-3p10-DialogService.md | 1 + .../3-UI/9-Migration-3p10-ModalService.md | 1 + .../docs/migration-guide/3p9-to-3p10/index.md | 2 + .../docs/migration-guide/from-3p7-to-3p8.md | 2 + platform/docs/docs/migration-guide/from-v2.md | 2 + platform/docs/docs/migration-guide/index.md | 2 + .../docs/docs/platform/browser-support.md | 2 + .../docs/platform/environment-variables.md | 2 + .../docs/platform/extensions/extension.md | 2 + .../docs/docs/platform/extensions/index.md | 2 + .../docs/platform/extensions/installation.md | 2 + .../docs/platform/extensions/lifecycle.md | 2 + .../platform/extensions/modules/commands.md | 2 + .../extensions/modules/contextModule.md | 2 + .../extensions/modules/data-source.md | 2 + .../platform/extensions/modules/hpModule.md | 2 + .../extensions/modules/layout-template.md | 2 + .../docs/platform/extensions/modules/panel.md | 2 + .../extensions/modules/sop-class-handler.md | 2 + .../platform/extensions/modules/toolbar.md | 2 + .../platform/extensions/modules/utility.md | 2 + .../platform/extensions/modules/viewport.md | 2 + .../docs/platform/internationalization.md | 2 + .../docs/docs/platform/managers/commands.md | 2 + .../docs/docs/platform/managers/extension.md | 2 + .../docs/docs/platform/managers/hotkeys.md | 2 + platform/docs/docs/platform/managers/index.md | 2 + .../docs/docs/platform/managers/service.md | 2 + platform/docs/docs/platform/modes/index.md | 2 + .../docs/docs/platform/modes/installation.md | 2 + .../docs/docs/platform/modes/lifecycle.md | 2 + platform/docs/docs/platform/modes/routes.md | 2 + platform/docs/docs/platform/modes/validity.md | 2 + .../docs/docs/platform/pwa-vs-packaged.md | 2 + .../docs/docs/platform/scope-of-project.md | 2 + .../customization-service/Measurements.md | 4 +- .../customization-service/Segmentation.md | 4 +- .../customization-service/StudyBrowser.md | 4 +- .../customization-service/advanced.md | 2 + .../customization-service/contextMenu.md | 2 + .../customization-service/customRoutes.md | 2 + .../customizationService.md | 2 + .../customization-service/viewportOverlay.md | 3 + .../services/data/DicomMetadataStore.md | 2 + .../services/data/DisplaySetService.md | 2 + .../services/data/HangingProtocolService.md | 2 + .../services/data/MeasurementService.md | 2 + .../services/data/MultiMonitorService.md | 2 + .../platform/services/data/PanelService.md | 2 + .../services/data/SegmentationService.md | 2 + .../services/data/SyncGroupService.md | 2 + .../services/data/ToolGroupService.md | 2 + .../platform/services/data/ToolbarService.md | 2 + .../services/data/WorkflowStepService.md | 2 + .../docs/docs/platform/services/data/index.md | 2 + platform/docs/docs/platform/services/index.md | 2 + .../docs/docs/platform/services/pubsub.md | 2 + .../docs/platform/services/ui/cine-service.md | 2 + .../docs/docs/platform/services/ui/index.md | 2 + .../platform/services/ui/ui-dialog-service.md | 2 + .../platform/services/ui/ui-modal-service.md | 2 + .../services/ui/ui-notification-service.md | 2 + .../services/ui/ui-viewport-dialog-service.md | 2 + .../services/ui/viewport-action-menu.md | 2 + .../services/ui/viewport-grid-service.md | 2 + platform/docs/docs/platform/themeing.md | 2 + platform/docs/docs/release-notes.md | 2 + platform/docs/docs/resources.md | 2 + platform/docs/docs/test-coverage.md | 2 + platform/docs/package.json | 7 +- platform/docs/scripts/README.md | 101 ++++++ .../docs/scripts/generate-llms-full-txt.js | 291 ++++++++++++++++++ platform/docs/scripts/generate-llms-txt.js | 142 +++++++++ .../docs/scripts/prepare-markdown-files.js | 67 ++++ 149 files changed, 865 insertions(+), 7 deletions(-) create mode 100644 platform/docs/scripts/README.md create mode 100644 platform/docs/scripts/generate-llms-full-txt.js create mode 100644 platform/docs/scripts/generate-llms-txt.js create mode 100644 platform/docs/scripts/prepare-markdown-files.js diff --git a/platform/docs/docs/configuration/configurationFiles.md b/platform/docs/docs/configuration/configurationFiles.md index be6829c74..c69f4dfbc 100644 --- a/platform/docs/docs/configuration/configurationFiles.md +++ b/platform/docs/docs/configuration/configurationFiles.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Configuration Files +title: Configuration Files +summary: Comprehensive guide to configuring OHIF Viewer, including data sources, environment variables, advanced options like study prefetching, and detailed explanations of configuration parameters for performance optimization and feature customization. --- # Config files diff --git a/platform/docs/docs/configuration/dataSources/configuration-ui.md b/platform/docs/docs/configuration/dataSources/configuration-ui.md index 200fc167f..0b76d58fc 100644 --- a/platform/docs/docs/configuration/dataSources/configuration-ui.md +++ b/platform/docs/docs/configuration/dataSources/configuration-ui.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Configuration UI +title: Configuration UI +summary: Describes interfaces for implementing configurable data sources in OHIF, with details on BaseDataSourceConfigurationAPI and BaseDataSourceConfigurationAPIItem to enable generic UIs for hierarchical data source configuration. --- # Configuration UI diff --git a/platform/docs/docs/configuration/dataSources/dicom-json.md b/platform/docs/docs/configuration/dataSources/dicom-json.md index 84e7be228..a183c47d1 100644 --- a/platform/docs/docs/configuration/dataSources/dicom-json.md +++ b/platform/docs/docs/configuration/dataSources/dicom-json.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: DICOM JSON +title: DICOM JSON +summary: Explains how to configure and use the DICOM JSON data source format in OHIF, including structure of the JSON file with study/series/instance metadata, implementation examples, and local deployment instructions. --- # DICOM JSON diff --git a/platform/docs/docs/configuration/dataSources/dicom-web-proxy.md b/platform/docs/docs/configuration/dataSources/dicom-web-proxy.md index faeea85e6..8f96bc96d 100644 --- a/platform/docs/docs/configuration/dataSources/dicom-web-proxy.md +++ b/platform/docs/docs/configuration/dataSources/dicom-web-proxy.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: DICOMweb Proxy +title: DICOMweb Proxy +summary: Documents the DICOMweb Proxy data source which constructs a dynamic DICOMweb datasource from a configuration JSON file, allowing OHIF to delegate subsequent requests for metadata and images to the configured server. --- # DICOMweb Proxy diff --git a/platform/docs/docs/configuration/dataSources/dicom-web.md b/platform/docs/docs/configuration/dataSources/dicom-web.md index 2707370fe..b04c11983 100644 --- a/platform/docs/docs/configuration/dataSources/dicom-web.md +++ b/platform/docs/docs/configuration/dataSources/dicom-web.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: DICOMweb +title: DICOMweb +summary: Comprehensive guide to configuring DICOMweb data sources in OHIF, including setting up local DICOM servers (Orthanc, DCM4CHEE), configurations for PDF, video, and bulkdata handling, and detailed instructions for development environments. --- # DICOMweb diff --git a/platform/docs/docs/configuration/dataSources/introduction.md b/platform/docs/docs/configuration/dataSources/introduction.md index 2a0add515..e66c647ac 100644 --- a/platform/docs/docs/configuration/dataSources/introduction.md +++ b/platform/docs/docs/configuration/dataSources/introduction.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: Data Source Introduction +summary: Introduces OHIF's data structure based on naturalized DICOM JSON format, providing an overview of common data sources available in OHIF and how custom data sources can be implemented. --- # Data Source diff --git a/platform/docs/docs/configuration/dataSources/static-files.md b/platform/docs/docs/configuration/dataSources/static-files.md index ec460db2b..7746935bf 100644 --- a/platform/docs/docs/configuration/dataSources/static-files.md +++ b/platform/docs/docs/configuration/dataSources/static-files.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Static Files +title: Static DICOMweb Files +summary: Details how to use the static-wado project to generate and serve optimized static DICOMweb files for enhanced OHIF Viewer performance, with step-by-step instructions for installation, file generation, and viewer configuration. --- diff --git a/platform/docs/docs/configuration/tours.md b/platform/docs/docs/configuration/tours.md index 340800053..2bcfb8329 100644 --- a/platform/docs/docs/configuration/tours.md +++ b/platform/docs/docs/configuration/tours.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Tours +title: Configuring Tours in OHIF +summary: Guide to implementing interactive guided tours in OHIF using Shepherd.js, including detailed configuration options, step definitions, customization parameters, and examples for creating effective user onboarding experiences. --- # Configuring Tours in OHIF with Shepherd.js diff --git a/platform/docs/docs/configuration/url.md b/platform/docs/docs/configuration/url.md index cac7e5ad4..2fa3a736d 100644 --- a/platform/docs/docs/configuration/url.md +++ b/platform/docs/docs/configuration/url.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: URL +title: URL Parameters +summary: Reference for OHIF Viewer URL parameters that control WorkList filtering, study/series loading, and viewer behavior, including parameters for filtering by patient name, modality, data sources, specifying initial series/instances, and selecting hanging protocols. --- # URL diff --git a/platform/docs/docs/conformance.md b/platform/docs/docs/conformance.md index ac34b46de..f83322a85 100644 --- a/platform/docs/docs/conformance.md +++ b/platform/docs/docs/conformance.md @@ -2,6 +2,7 @@ sidebar_position: 12 sidebar_label: DICOM Conformance Statement title: DICOM Conformance Statement +summary: Access information about the OHIF Viewer's compliance with DICOM standards through an open-sourced document provided by Radical Imaging, which details the application's implementation of DICOM protocols and services. --- You can find a version that has been open sourced by Radical Imaging [in this link](https://docs.google.com/document/d/1hbDlUApX4svX33gAUGxGfD7fXXZNaBsX0hSePbc-hNA/edit?usp=sharing) diff --git a/platform/docs/docs/deployment/authorization.md b/platform/docs/docs/deployment/authorization.md index b3589b1a9..76abd915b 100644 --- a/platform/docs/docs/deployment/authorization.md +++ b/platform/docs/docs/deployment/authorization.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Auth +title: Authorization and Authentication +summary: Guide to configuring OpenID-Connect authentication in OHIF Viewer, including setup of authorization flows, token handling, and implementation details for securing access to medical imaging data. --- # Authorization and Authentication diff --git a/platform/docs/docs/deployment/azure.md b/platform/docs/docs/deployment/azure.md index 219532d90..983eafa4c 100644 --- a/platform/docs/docs/deployment/azure.md +++ b/platform/docs/docs/deployment/azure.md @@ -1,5 +1,7 @@ --- sidebar_position: 12 +title: Microsoft Azure Integration +summary: Comprehensive guide for configuring OHIF with Microsoft Azure Healthcare APIs, including step-by-step instructions for Azure AD registration, DICOM service setup, CORS configuration, and OAuth authentication implementation. --- # Microsoft Azure diff --git a/platform/docs/docs/deployment/build-for-production.md b/platform/docs/docs/deployment/build-for-production.md index dbd89a8a9..f4521327f 100644 --- a/platform/docs/docs/deployment/build-for-production.md +++ b/platform/docs/docs/deployment/build-for-production.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: Build for Production +summary: Step-by-step guide to building a production-ready version of the OHIF Viewer, including environment setup, code acquisition, dependency restoration, production build creation, and configuration options for deployment. --- # Build for Production diff --git a/platform/docs/docs/deployment/cors.md b/platform/docs/docs/deployment/cors.md index 7035ab213..315e10fd5 100644 --- a/platform/docs/docs/deployment/cors.md +++ b/platform/docs/docs/deployment/cors.md @@ -1,5 +1,7 @@ --- sidebar_position: 8 +title: Cross-Origin Resource Sharing +summary: Detailed explanation of cross-origin security configurations for OHIF Viewer, covering CORS requirements for data source access, iframe embedding, secure contexts, and troubleshooting techniques for proper implementation. --- # Cross-Origin Information for OHIF diff --git a/platform/docs/docs/deployment/custom-url-access.md b/platform/docs/docs/deployment/custom-url-access.md index c4639aedf..7ec16626f 100644 --- a/platform/docs/docs/deployment/custom-url-access.md +++ b/platform/docs/docs/deployment/custom-url-access.md @@ -1,6 +1,7 @@ --- sidebar_position: 4 title: Custom URL Access/Build +summary: "Instructions for hosting the OHIF Viewer on custom URL paths, with two deployment approaches: simple setup for serving the viewer from a subpath with assets at the root, and advanced setup for custom asset paths with detailed configuration steps." --- diff --git a/platform/docs/docs/deployment/docker/docker.md b/platform/docs/docs/deployment/docker/docker.md index e9c7e212f..327782fc2 100644 --- a/platform/docs/docs/deployment/docker/docker.md +++ b/platform/docs/docs/deployment/docker/docker.md @@ -1,5 +1,7 @@ --- sidebar_position: 4 +title: Docker Deployment +summary: Comprehensive guide for deploying OHIF Viewer using Docker, covering pre-built images from Docker Hub, custom image building, configuration options through build arguments and environment variables, and runtime container management. --- # Docker diff --git a/platform/docs/docs/deployment/docker/ssl.md b/platform/docs/docs/deployment/docker/ssl.md index 1942468ec..b6650ba0a 100644 --- a/platform/docs/docs/deployment/docker/ssl.md +++ b/platform/docs/docs/deployment/docker/ssl.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 -title: SSL +title: SSL Configuration for Docker +summary: Guide to configuring SSL for OHIF Viewer in Docker deployments, including environment variable setup, certificate mounting, permissions management, and instructions for both CA-signed and self-signed certificate implementation. --- # SSL diff --git a/platform/docs/docs/deployment/google-cloud-healthcare.md b/platform/docs/docs/deployment/google-cloud-healthcare.md index 54df8bb02..6fef07c6a 100644 --- a/platform/docs/docs/deployment/google-cloud-healthcare.md +++ b/platform/docs/docs/deployment/google-cloud-healthcare.md @@ -1,5 +1,7 @@ --- sidebar_position: 9 +title: Google Cloud Healthcare Integration +summary: Guide to setting up Google Cloud Healthcare API as a DICOM data source for OHIF, including project creation, API configuration, OAuth authentication setup, and implementation details for connecting the viewer to Google-hosted medical imaging data. --- # Google Cloud Healthcare diff --git a/platform/docs/docs/deployment/iframe.md b/platform/docs/docs/deployment/iframe.md index 671756911..c4460052e 100644 --- a/platform/docs/docs/deployment/iframe.md +++ b/platform/docs/docs/deployment/iframe.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: iframe +title: Embedding OHIF in an iframe +summary: Guidelines for embedding OHIF Viewer within other applications using iframe integration, explaining configuration requirements for path settings, static builds, and proper setup to ensure WebWorkers, WASM, and WebGL features function correctly. --- # iframe diff --git a/platform/docs/docs/deployment/index.md b/platform/docs/docs/deployment/index.md index 6698c607f..7b8ca8810 100644 --- a/platform/docs/docs/deployment/index.md +++ b/platform/docs/docs/deployment/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Overview +title: Deployment Overview +summary: Comprehensive guide to deploying the OHIF Viewer as a standalone web application or embedded iframe, covering data source configuration, security considerations, and various deployment options with examples for different hosting environments. --- # Deployment diff --git a/platform/docs/docs/deployment/nginx--image-archive.md b/platform/docs/docs/deployment/nginx--image-archive.md index b1a2fd34b..1f77a5f3a 100644 --- a/platform/docs/docs/deployment/nginx--image-archive.md +++ b/platform/docs/docs/deployment/nginx--image-archive.md @@ -1,5 +1,7 @@ --- sidebar_position: 10 +title: Nginx + Image Archive Setup +summary: Tutorial for setting up OHIF Viewer with Nginx and PACS (Orthanc or DCM4CHEE), using Docker for a production-ready system with reverse proxy configuration to securely handle medical imaging data, including installation steps and troubleshooting tips. --- # Nginx + Image Archive diff --git a/platform/docs/docs/deployment/static-assets.md b/platform/docs/docs/deployment/static-assets.md index 4186a1b3c..d04d7af0f 100644 --- a/platform/docs/docs/deployment/static-assets.md +++ b/platform/docs/docs/deployment/static-assets.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: Deploy Static Assets +summary: Guide to deploying OHIF Viewer static assets using various hosting options, from simple drag-and-drop methods like Netlify to more advanced cloud platforms like AWS, GCP, and Azure, with step-by-step instructions for each deployment approach. --- # Deploy Static Assets diff --git a/platform/docs/docs/deployment/user-account-control.md b/platform/docs/docs/deployment/user-account-control.md index 87f0235be..91fa965d0 100644 --- a/platform/docs/docs/deployment/user-account-control.md +++ b/platform/docs/docs/deployment/user-account-control.md @@ -1,5 +1,7 @@ --- sidebar_position: 11 +title: User Account Control +summary: Comprehensive guide for implementing user authentication in OHIF using Keycloak, covering setup with both Orthanc and DCM4CHEE, configuration with OAuth2 proxy, SSL implementation, and detailed steps for local and production deployment scenarios. --- # User Account Control diff --git a/platform/docs/docs/development/android-ios-debugging.md b/platform/docs/docs/development/android-ios-debugging.md index 67c42734a..1e5ebe8a7 100644 --- a/platform/docs/docs/development/android-ios-debugging.md +++ b/platform/docs/docs/development/android-ios-debugging.md @@ -1,6 +1,8 @@ --- sidebar_position: 12 sidebar_label: Android & iOS Debugging +title: Android & iOS Debugging +summary: Comprehensive guide for debugging OHIF Viewer on mobile devices, covering setup of Android and iOS emulators, step-by-step instructions for connecting Chrome DevTools and Safari Web Inspector, and video tutorials demonstrating the debugging workflow. --- # Android & iOS Debugging for OHIF using Emulators diff --git a/platform/docs/docs/development/architecture.md b/platform/docs/docs/development/architecture.md index f191f16ed..ea7587a42 100644 --- a/platform/docs/docs/development/architecture.md +++ b/platform/docs/docs/development/architecture.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Architecture +title: OHIF Architecture +summary: Detailed explanation of OHIF Viewer's architecture, covering the platform's core components, extensions system, modes concept, and the relationships between these elements that enable building flexible and extensible medical imaging applications. --- # Architecture diff --git a/platform/docs/docs/development/continuous-integration.md b/platform/docs/docs/development/continuous-integration.md index 48ad4c4d0..15055a374 100644 --- a/platform/docs/docs/development/continuous-integration.md +++ b/platform/docs/docs/development/continuous-integration.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Continuous Integration +title: Continuous Integration +summary: Overview of OHIF's CI/CD setup using CircleCI and Netlify, detailing workflows for pull request checks, optional Docker image publishing, deployment to development/staging/production environments, and the release process for npm packages and documentation. --- # Continuous Integration (CI) diff --git a/platform/docs/docs/development/contributing.md b/platform/docs/docs/development/contributing.md index 5e513b7c3..a0d9f0c9e 100644 --- a/platform/docs/docs/development/contributing.md +++ b/platform/docs/docs/development/contributing.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Contributing +title: Contributing to OHIF +summary: Guidelines for contributing to the OHIF project, including best practices for submitting pull requests, working with multiple repositories, and advice on creating changes that are more likely to be accepted by the core team. --- # Contributing diff --git a/platform/docs/docs/development/getting-started.md b/platform/docs/docs/development/getting-started.md index 32214b66f..c23bc9bcf 100644 --- a/platform/docs/docs/development/getting-started.md +++ b/platform/docs/docs/development/getting-started.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Getting Started +title: Getting Started with OHIF Development +summary: Quick start guide for OHIF development, covering repository setup options, branch organization, development environment requirements, project initialization, and steps for building production-ready assets. --- # Getting Started diff --git a/platform/docs/docs/development/link.md b/platform/docs/docs/development/link.md index 5d8882fd1..40bd2c214 100644 --- a/platform/docs/docs/development/link.md +++ b/platform/docs/docs/development/link.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: Local Linking +title: Local Library Linking +summary: Brief introduction to the concept of local linking for library development in OHIF, explaining how to test libraries in application context before publishing, with reference to Cornerstonejs linking documentation. --- # Introduction diff --git a/platform/docs/docs/development/ohif-cli.md b/platform/docs/docs/development/ohif-cli.md index 038f331a9..1cc90db3e 100644 --- a/platform/docs/docs/development/ohif-cli.md +++ b/platform/docs/docs/development/ohif-cli.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: OHIF CLI +title: OHIF Command Line Interface +summary: Comprehensive guide to the OHIF CLI tool for managing extensions and modes, including commands for creating, linking, adding, removing, and publishing components, with detailed examples and explanations of the underlying configuration system. --- # OHIF Command Line Interface diff --git a/platform/docs/docs/development/our-process.md b/platform/docs/docs/development/our-process.md index 263135b1f..cda269eef 100644 --- a/platform/docs/docs/development/our-process.md +++ b/platform/docs/docs/development/our-process.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Issue & PR Triage Process +title: OHIF Development Process +summary: Detailed explanation of OHIF's issue triage, backlog management, contribution evaluation, and release processes, including categorization of issues, pull request workflow, quality assurance procedures, and continuous integration practices. --- # Our Process diff --git a/platform/docs/docs/development/playwright-testing.md b/platform/docs/docs/development/playwright-testing.md index f85f02d33..e456a7e67 100644 --- a/platform/docs/docs/development/playwright-testing.md +++ b/platform/docs/docs/development/playwright-testing.md @@ -1,6 +1,8 @@ --- sidebar_position: 11 sidebar_label: Playwright Testing +title: Playwright End-to-End Testing +summary: Guide to writing and running end-to-end tests for OHIF Viewer using Playwright, covering test configuration, screenshot verification, simulating user interactions, accessing application services, and using the VSCode extension for test recording. --- diff --git a/platform/docs/docs/development/testing.md b/platform/docs/docs/development/testing.md index 23f239755..fb7322696 100644 --- a/platform/docs/docs/development/testing.md +++ b/platform/docs/docs/development/testing.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: Testing +title: Testing OHIF +summary: Comprehensive guide to OHIF's testing approach, covering unit tests and end-to-end tests with detailed instructions for running them, explanation of test data management, and an overview of the project's testing philosophy and best practices. --- # Running Tests for OHIF diff --git a/platform/docs/docs/development/types.md b/platform/docs/docs/development/types.md index a6af5df12..e048c98bb 100644 --- a/platform/docs/docs/development/types.md +++ b/platform/docs/docs/development/types.md @@ -1,6 +1,8 @@ --- sidebar_position: 10 sidebar_label: Global Types +title: Global Types and Service Extensions +summary: Guide to using and extending TypeScript types in OHIF applications, focusing on the withAppTypes utility for component typing, adding custom properties, and properly integrating new services into the global namespace for type safety and code completion. --- # Extending App Types and Services in Your Application diff --git a/platform/docs/docs/development/video-tutorials.md b/platform/docs/docs/development/video-tutorials.md index 482967e26..15ffa4f5c 100644 --- a/platform/docs/docs/development/video-tutorials.md +++ b/platform/docs/docs/development/video-tutorials.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Video Tutorials +title: OHIF Development Video Tutorials +summary: Collection of instructional videos demonstrating key OHIF development workflows, including creating, linking, and publishing modes and extensions, with step-by-step demonstrations of the OHIF CLI and NPM publishing process. --- # Video Tutorials diff --git a/platform/docs/docs/development/webWorkers.md b/platform/docs/docs/development/webWorkers.md index 7fa3bed1a..c90e6af23 100644 --- a/platform/docs/docs/development/webWorkers.md +++ b/platform/docs/docs/development/webWorkers.md @@ -1,6 +1,8 @@ --- sidebar_position: 13 sidebar_label: Web Workers +title: Web Workers Implementation Guide +summary: Step-by-step guide for implementing web workers in OHIF to handle computationally intensive tasks in background threads, including worker creation, registration, task execution, progress tracking, and best practices for code organization. --- # Web Worker Implementation Guide diff --git a/platform/docs/docs/faq/general.md b/platform/docs/docs/faq/general.md index 2c01de7d1..7e0619b72 100644 --- a/platform/docs/docs/faq/general.md +++ b/platform/docs/docs/faq/general.md @@ -1,5 +1,7 @@ --- id: general +title: General FAQ +summary: Answers to common questions about OHIF Viewer, including how to report bugs, request features, contact for support or academic collaborations, regulatory compliance status (FDA/CE/HIPAA), and obtaining sample studies. --- diff --git a/platform/docs/docs/faq/index.md b/platform/docs/docs/faq/index.md index e44af0f30..30a56b434 100644 --- a/platform/docs/docs/faq/index.md +++ b/platform/docs/docs/faq/index.md @@ -1,5 +1,7 @@ --- id: index +title: OHIF Viewer FAQ +summary: Comprehensive list of frequently asked questions about the OHIF Viewer, covering common inquiries about reporting bugs, requesting features, academic collaborations, regulatory status, and obtaining demo studies. --- diff --git a/platform/docs/docs/faq/technical.md b/platform/docs/docs/faq/technical.md index bee5b8f7e..1b65ec67d 100644 --- a/platform/docs/docs/faq/technical.md +++ b/platform/docs/docs/faq/technical.md @@ -1,3 +1,9 @@ +--- +id: technical +title: Technical FAQ +summary: Technical explanations and solutions for OHIF Viewer implementation challenges, including required metadata fields, handling large volumes for MPR/rendering, dynamically loading measurements, customizing series sorting, and addressing common rendering issues. +--- + # Technical FAQ diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/0-general.md b/platform/docs/docs/migration-guide/3p8-to-3p9/0-general.md index 3439456b0..5159f5249 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/0-general.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/0-general.md @@ -1,6 +1,7 @@ --- id: 0-general title: General +summary: General migration changes from OHIF 3.8 to 3.9, including removing SharedArrayBuffer requirements, React 18 updates, Polyfill removal, webpack changes, scroll utility relocation, Crosshairs improvements, and toolbar button evaluation enhancements. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md index c8a92efa0..2f89a7b4d 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md @@ -1,6 +1,7 @@ --- id: seg-new-arch title: New Architecture +summary: Overview of the new viewport-centric segmentation architecture in OHIF 3.9, which replaces the previous toolGroup-centric approach and introduces clearer separation between segmentation data and its visual representation. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md index 06601b7cd..3bb7356a6 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md @@ -1,6 +1,7 @@ --- id: seg-api title: SegmentationService API +summary: Detailed guide to the SegmentationService API changes in OHIF 3.9, covering the transition from toolGroup to viewport-centric segmentation management, updates to key methods like getActiveSegmentation, setActiveSegmentation, and addSegment. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md index 522259276..4e6e6f8f3 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md @@ -1,6 +1,7 @@ --- id: seg-representation title: Segmentation Representations +summary: Migration guide for segmentation representation management in OHIF 3.9, explaining the transition from toolGroup-based to viewport-centric representation handling, and introducing the new specifier pattern for more flexible API usage. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md index c70021e33..7d3b65b7f 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md @@ -1,6 +1,7 @@ --- id: seg-creation -title: Segmentation Creation +title: Segmentation Creation +summary: Migration guide for segmentation creation methods in OHIF 3.9, covering renamed methods like createLabelmapForViewport and createLabelmapForDisplaySet, updated parameter structures, and transition from tool group to viewport-centric approach. --- ## createEmptySegmentationForViewport diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md index ebe16f7c1..f63f41df2 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md @@ -1,6 +1,7 @@ --- id: seg-service-mod title: SegmentationService Modifications +summary: Migration guide for segmentation representation management API changes in OHIF 3.9, showing how to transition from tool group-based methods to viewport-centric approaches for adding, removing, and querying segmentation representations. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md index 266206bf1..44afef24c 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md @@ -1,6 +1,7 @@ --- id: seg-style title: SegmentationService Style +summary: Migration guide for segmentation styling API changes in OHIF 3.9, covering the transition to viewport-specific visibility controls, new style specification system using the specifier pattern, and updated methods for setting colors and toggling visibility. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md index 1236787e1..a13cd718f 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md @@ -1,6 +1,7 @@ --- id: seg-other title: Other Changes +summary: Migration guide for additional segmentation service changes in OHIF 3.9, covering updates to addOrUpdateSegmentation with new data structures, loadSegmentationsForViewport, highlightSegment, and jumpToSegmentCenter methods with viewport-centric approach. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/index.md b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/index.md index f4a7a6744..b6fa29f88 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/index.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/1-segmentation/index.md @@ -2,6 +2,7 @@ id: segmentation-index title: Segmentation sidebar_position: 1 +summary: Migration guide for segmentation architecture changes in OHIF 3.9, covering the shift from tool group-centric to viewport-centric architecture to support advanced visualization capabilities and more flexible segmentation handling. --- import DocCardList from '@theme/DocCardList'; diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/2-Renamings.md b/platform/docs/docs/migration-guide/3p8-to-3p9/2-Renamings.md index 6c0763f3c..95866fe74 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/2-Renamings.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/2-Renamings.md @@ -2,6 +2,7 @@ id: 2-renamings title: Renamings sidebar_position: 2 +summary: Migration guide for renamed components in OHIF 3.9, including the Panel Measurements name change from 'measure' to 'panelMeasurement' and addIcon utility changes to support both UI packages. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/3-DataSources.md b/platform/docs/docs/migration-guide/3p8-to-3p9/3-DataSources.md index 2d14adf53..26f7c97cf 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/3-DataSources.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/3-DataSources.md @@ -2,6 +2,7 @@ id: 3-data-sources title: Data Sources sidebar_position: 3 +summary: Migration guide for BulkDataURI configuration changes in OHIF 3.9, explaining the transition from a simple boolean flag to a more flexible configuration object with additional control options. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/4-Measurements.md b/platform/docs/docs/migration-guide/3p8-to-3p9/4-Measurements.md index d4b89faf3..8db5dd774 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/4-Measurements.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/4-Measurements.md @@ -1,5 +1,6 @@ --- title: Measurements +summary: Migration guide for measurement changes in OHIF 3.9, covering the new structured 'displayText' object with primary and secondary arrays for better organization, and the renaming of 'selected' property to 'isSelected'. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md b/platform/docs/docs/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md index 7b85dafc0..74a02af61 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md @@ -1,6 +1,7 @@ --- id: viewport-action-corner title: ViewportActionCorner +summary: Migration guide for ViewportActionCornerService in OHIF 3.9, introducing the new addComponent and addComponents methods that provide more reliable positioning of multiple components within viewport corners. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/5-StateSyncService.md b/platform/docs/docs/migration-guide/3p8-to-3p9/5-StateSyncService.md index 230683c85..d12144406 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/5-StateSyncService.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/5-StateSyncService.md @@ -1,6 +1,7 @@ --- id: state-sync-service title: StateSyncService +summary: Migration guide for transitioning from StateSyncService to Zustand stores in OHIF 3.9, covering all store types including LutPresentationStore, PositionPresentationStore, ViewportGridStore, and more with examples of old and new API usage. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/6-RTSTRUCT.md b/platform/docs/docs/migration-guide/3p8-to-3p9/6-RTSTRUCT.md index f13bf9130..4ecc3ad6e 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/6-RTSTRUCT.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/6-RTSTRUCT.md @@ -2,6 +2,7 @@ id: 6-rtstruct title: RTSTRUCT sidebar_position: 6 +summary: Migration guide for RT Structure Set rendering in OHIF 3.9, explaining the transition from VTK-based rendering to SVG-based rendering for improved stability and speed while maintaining stack viewports instead of converting to volume viewports. --- diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/7-UI.md b/platform/docs/docs/migration-guide/3p8-to-3p9/7-UI.md index 2be4fabf0..74fd307e7 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/7-UI.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/7-UI.md @@ -1,5 +1,6 @@ --- title: UI +summary: Migration guide for UI changes in OHIF 3.9, covering the new UI components from @ohif/ui-next, UINotificationService updates with Sonner integration, viewport pane Tailwind class changes, Header component refactoring, and managing both UI libraries. --- ## New Components diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/8-Refactorings.md b/platform/docs/docs/migration-guide/3p8-to-3p9/8-Refactorings.md index c90717d88..2a6fab362 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/8-Refactorings.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/8-Refactorings.md @@ -1,5 +1,6 @@ --- title: Refactoring +summary: Migration guide for refactored components in OHIF 3.9, including the move of PanelSegmentation from cornerstone-dicom-seg extension to cornerstone extension, centralization of dialog utilities, and improved customization ID structure for better modularity. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/9-other.md b/platform/docs/docs/migration-guide/3p8-to-3p9/9-other.md index 5bd8b735d..8c2a3cebd 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/9-other.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/9-other.md @@ -1,5 +1,6 @@ --- title: Other Changes +summary: Migration guide for additional changes in OHIF 3.9, covering external library loading with browserImport function, the pluginConfig.json format for dynamic imports, and improvements to viewport navigation using ViewReference methods. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/docs/migration-guide/3p8-to-3p9/index.md b/platform/docs/docs/migration-guide/3p8-to-3p9/index.md index c962a5d55..c6f3393c3 100644 --- a/platform/docs/docs/migration-guide/3p8-to-3p9/index.md +++ b/platform/docs/docs/migration-guide/3p8-to-3p9/index.md @@ -2,6 +2,7 @@ id: 3p8-to-3p9 title: 3.8 -> 3.9 sidebar_position: 2 +summary: Migration guide for upgrading from OHIF 3.8 to 3.9, covering segmentation architecture changes, renamings, data sources, measurements, viewport action corners, state sync service, RT structure improvements, UI changes, and other refactorings. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/commands.md b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/commands.md index 814692669..0f2198be5 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/commands.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/commands.md @@ -1,5 +1,6 @@ --- title: Commands +summary: Migration guide for commands in OHIF 3.10, covering the replacement of deleteMeasurement with removeMeasurement and setSourceViewportForReferenceLinesTool with the more generic setViewportForToolConfiguration command. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/general-m.md b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/general-m.md index 22b7512ac..6ff64c941 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/general-m.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/general-m.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: General +summary: General migration changes from OHIF 3.9 to 3.10, including Node.js version update, HTML template modifications, bundled Google Fonts, docs updates, faster development builds with rsbuild, and webpack configuration changes for AI segmentation support. --- ## Node.js Version Update diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/hotkeys.md b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/hotkeys.md index 80fc94a31..b2a01d617 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/hotkeys.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/hotkeys.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 title: Hotkeys +summary: Migration guide for hotkeys management in OHIF 3.10, explaining the transition from defining hotkeys in mode factory to using the customizationService, with examples of replacing, adding, and modifying hotkey bindings. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/routerBaseName.md b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/routerBaseName.md index de39916ac..e6eb0b3c4 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/routerBaseName.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/1-General/routerBaseName.md @@ -1,5 +1,6 @@ --- title: routerBaseName +summary: Migration guide for router configuration in OHIF 3.10, covering the updated default behavior of routerBasename and its interaction with PUBLIC_URL, with scenario-based examples for both root and subpath hosting. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/2-CustomizationService/index.md b/platform/docs/docs/migration-guide/3p9-to-3p10/2-CustomizationService/index.md index ad3252fc6..9d2db05b0 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/2-CustomizationService/index.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/2-CustomizationService/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 title: Customization Service +summary: Migration guide for OHIF's Customization Service from 3.9 to 3.10, covering unified customization getters, simplified registration, new commands, renamed customizations, and updated patterns for modifying UI components. --- # CustomizationService diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md index 230c78d3a..39c2335e0 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md @@ -1,6 +1,7 @@ --- title: Introduction position: 1 +summary: Introduction to UI changes in OHIF 3.10, covering the migration of the image viewer to the @ohif/ui-next library, a complete rewrite of UI components offering extensibility, accessibility, and a modern design, with guidance on updating custom panels. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md index 17e8a9689..45c4cef3c 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md @@ -1,5 +1,6 @@ --- title: Tests +summary: Migration guide for test updates in OHIF 3.10, covering changes to how tools are identified and tested, including the transition from class-based to data-attribute-based selection in Cypress tests. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md index ea98850b0..14b7313b4 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md @@ -1,5 +1,6 @@ --- title: Colors +summary: Migration guide for OHIF 3.10's new color system, explaining the transition from custom color names to a semantic color palette using CSS variables, with detailed mapping of old color classes to new Tailwind equivalents. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md index 7a2afed4d..5845629d2 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md @@ -1,5 +1,6 @@ --- title: Icons +summary: Migration guide for OHIF 3.10's Icon component updates, covering the transition from @ohif/ui to @ohif/ui-next with new PascalCase naming conventions, legacy fallback options, and a comprehensive renaming table for all icons. --- ## Migration Guide: Icon Component Updates diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md index 887966a14..a1acdb739 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md @@ -1,5 +1,6 @@ --- title: Button +summary: Migration guide for Button components in OHIF 3.10, explaining the transition from @ohif/ui to @ohif/ui-next, the replacement of ButtonEnums with string-based variants, and changes to IconButton, ButtonGroup, and styling approach. --- ## Key Changes: diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md index bc4816cea..a2b2e57aa 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md @@ -1,5 +1,6 @@ --- title: Input +summary: Migration guide for input components in OHIF 3.10, covering the transition from Input, InputNumber, InputRange, InputDoubleRange and others to the new Numeric component system and updated input patterns in @ohif/ui-next. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md index 80a33acaa..90796a2ca 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md @@ -1,5 +1,6 @@ --- title: Tooltip +summary: Migration guide for Tooltip components in OHIF 3.10, explaining the new composable structure with TooltipTrigger and TooltipContent, and replacement of TooltipClipboard with the Clipboard component. --- ## Tooltip Updates diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md index 27e5cdf28..ee708385f 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md @@ -1,5 +1,6 @@ --- -title: Tooltip +title: Select +summary: Migration guide for Select components in OHIF 3.10, explaining the transition from @ohif/ui to @ohif/ui-next, with details on the new Select.Root, Select.Trigger, Select.Content, and Select.Item structure replacing the old dropdown approach. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md index 981958eee..1f26ea69f 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md @@ -1,5 +1,6 @@ --- title: Switch +summary: Migration guide for Switch component in OHIF 3.10, covering the transition from custom Toggle and CinePlayPauseButton components to the standardized Switch component, with details on prop changes and usage patterns. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md index ae4041cc0..4c6c8ee1b 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md @@ -1,5 +1,6 @@ --- title: Toolbar +summary: Migration guide for toolbar components in OHIF 3.10, covering the new uiType values (ohif.toolButton and ohif.toolButtonList), section-based definitions replacing nested structures, ToolBox updates, and changes to tool option handlers. --- # Toolbar diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md index 713f44ec3..a02fef59c 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md @@ -1,5 +1,6 @@ --- title: Segmentation Table +summary: Migration guide for the refactored SegmentationTable component in OHIF 3.10, covering changes to the context system, compound component pattern adoption, replacement of SelectorHeader, and introduction of segment statistics features. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md index 16ac94663..d18dce99e 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md @@ -1,5 +1,6 @@ --- title: Tours and Onboarding +summary: Migration guide for Tours and Onboarding features in OHIF 3.10, explaining the transition from defining tours directly in window.config.tours to using the customization service, enabling mode-specific tours and better organization. --- ## Migration Guide: Tours diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md index 960029bda..276d23dcd 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md @@ -1,5 +1,6 @@ --- title: uiDialogService +summary: Migration guide for uiDialogService in OHIF 3.10, covering the transition from create/dismiss to show/hide methods, changes to dialog definition structure, and updates to utility functions like callInputDialog and colorPickerDialog. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md index 1cd2d9022..2bef21bc2 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md @@ -1,5 +1,6 @@ --- title: uiModalService +summary: Migration guide for the uiModalService in OHIF 3.10, covering props that remain unchanged, renamed props (containerDimensions to containerClassName), removed props (movable, isOpen, contentDimensions), and automatic handling of modal closing. --- diff --git a/platform/docs/docs/migration-guide/3p9-to-3p10/index.md b/platform/docs/docs/migration-guide/3p9-to-3p10/index.md index 3709d5fee..cf77d26f1 100644 --- a/platform/docs/docs/migration-guide/3p9-to-3p10/index.md +++ b/platform/docs/docs/migration-guide/3p9-to-3p10/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: 3.9 -> 3.10 beta +title: Migration Guide from 3.9 to 3.10 beta +summary: Migration guide for upgrading from OHIF 3.9 to 3.10 beta, covering general changes, customization service improvements, UI component upgrades, command handling, hotkey updates, routing changes, and testing strategies. --- # Migration Guide diff --git a/platform/docs/docs/migration-guide/from-3p7-to-3p8.md b/platform/docs/docs/migration-guide/from-3p7-to-3p8.md index b07d8ffe0..0b460dc33 100644 --- a/platform/docs/docs/migration-guide/from-3p7-to-3p8.md +++ b/platform/docs/docs/migration-guide/from-3p7-to-3p8.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: 3.7 -> 3.8 +title: Migration Guide from 3.7 to 3.8 +summary: Migration guide for upgrading from OHIF 3.7 to 3.8, covering changes to toolbar button definitions, active tool handling, button evaluators, tool listeners, leftPanel/rightPanel naming, URL parameters, UI components, and refactoring of enums. --- # Migration Guide diff --git a/platform/docs/docs/migration-guide/from-v2.md b/platform/docs/docs/migration-guide/from-v2.md index 920f4d095..aa5c531ed 100644 --- a/platform/docs/docs/migration-guide/from-v2.md +++ b/platform/docs/docs/migration-guide/from-v2.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: 2.x -> 3.5 +title: Migration Guide from 2.x to 3.5 +summary: Comprehensive migration guide for upgrading from OHIF 2.x to 3.5, covering architectural changes, UI improvements, extensions, modes, cornerstone3D integration, configuration changes, and build process updates. --- # Migration Guide diff --git a/platform/docs/docs/migration-guide/index.md b/platform/docs/docs/migration-guide/index.md index 85d2af849..a293b5cf4 100644 --- a/platform/docs/docs/migration-guide/index.md +++ b/platform/docs/docs/migration-guide/index.md @@ -1,5 +1,7 @@ --- id: index +title: Migration Guides Overview +summary: Introduction to OHIF migration guides covering the upgrade paths between different versions of the platform, with links to version-specific guides for migrating from one OHIF version to another. --- diff --git a/platform/docs/docs/platform/browser-support.md b/platform/docs/docs/platform/browser-support.md index fa31439c3..e98426213 100644 --- a/platform/docs/docs/platform/browser-support.md +++ b/platform/docs/docs/platform/browser-support.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: Browser Support +summary: Documentation of OHIF's browser compatibility standards, including supported browsers (IE11, Firefox, Chrome, Safari, Edge), transpilation and polyfill strategies, and development priorities focused on modern evergreen browsers. --- # Browser Support diff --git a/platform/docs/docs/platform/environment-variables.md b/platform/docs/docs/platform/environment-variables.md index df5da9e03..a316c9ed9 100644 --- a/platform/docs/docs/platform/environment-variables.md +++ b/platform/docs/docs/platform/environment-variables.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Environment Variables +title: Environment Variables +summary: Documentation of the environment variables used in OHIF during build time to configure application behavior, including application settings, internationalization options, and methods for setting these variables. --- # Environment Variables diff --git a/platform/docs/docs/platform/extensions/extension.md b/platform/docs/docs/platform/extensions/extension.md index 148b82a9f..706a7b049 100644 --- a/platform/docs/docs/platform/extensions/extension.md +++ b/platform/docs/docs/platform/extensions/extension.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Extension Manager +title: OHIF Extension Manager +summary: Documentation for OHIF's ExtensionManager class, which manages the registration and access of extensions, providing methods to retrieve module entries, access data sources, and handle extension configurations. --- # Extension Manager diff --git a/platform/docs/docs/platform/extensions/index.md b/platform/docs/docs/platform/extensions/index.md index d9c630ecb..1a1801ae4 100644 --- a/platform/docs/docs/platform/extensions/index.md +++ b/platform/docs/docs/platform/extensions/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: OHIF Extensions Introduction +summary: Comprehensive introduction to the OHIF viewer extension system, explaining how extensions provide modular functionality through different module types, and how they're configured and accessed in modes to build customized viewer experiences. --- # Introduction diff --git a/platform/docs/docs/platform/extensions/installation.md b/platform/docs/docs/platform/extensions/installation.md index 2e5fb81c2..af49ed17c 100644 --- a/platform/docs/docs/platform/extensions/installation.md +++ b/platform/docs/docs/platform/extensions/installation.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Installation +title: Extension Installation +summary: Instructions for installing external OHIF extensions using the OHIF CLI tool, which allows adding both local and published extensions from NPM to the viewer application. --- # Extension: Installation diff --git a/platform/docs/docs/platform/extensions/lifecycle.md b/platform/docs/docs/platform/extensions/lifecycle.md index 27868888c..489694c9c 100644 --- a/platform/docs/docs/platform/extensions/lifecycle.md +++ b/platform/docs/docs/platform/extensions/lifecycle.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Lifecycle Hooks +title: Extension Lifecycle Hooks +summary: Documentation for OHIF extension lifecycle hooks including preRegistration, onModeEnter, and onModeExit, which allow extensions to initialize resources, handle mode transitions, and clean up data when needed. --- # Extensions: Lifecycle Hooks diff --git a/platform/docs/docs/platform/extensions/modules/commands.md b/platform/docs/docs/platform/extensions/modules/commands.md index b37202bf6..840c5bc48 100644 --- a/platform/docs/docs/platform/extensions/modules/commands.md +++ b/platform/docs/docs/platform/extensions/modules/commands.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Commands +title: Commands Module +summary: Documentation for OHIF Commands Module, which allows extensions to register functions that can be called by tools, UI components, or hotkeys, with context-specific implementations and flexible command definitions. --- # Module: Commands diff --git a/platform/docs/docs/platform/extensions/modules/contextModule.md b/platform/docs/docs/platform/extensions/modules/contextModule.md index 35de381a3..f1bfe48b6 100644 --- a/platform/docs/docs/platform/extensions/modules/contextModule.md +++ b/platform/docs/docs/platform/extensions/modules/contextModule.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: Context +title: Context Module +summary: Documentation for OHIF Context Module, which enables component communication via React Context, allowing viewport and panel components to share state and synchronize through a common provider mechanism. --- # Module: Context diff --git a/platform/docs/docs/platform/extensions/modules/data-source.md b/platform/docs/docs/platform/extensions/modules/data-source.md index 5f682ff9c..3c8004219 100644 --- a/platform/docs/docs/platform/extensions/modules/data-source.md +++ b/platform/docs/docs/platform/extensions/modules/data-source.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Data Source +title: Data Source Module +summary: Documentation for OHIF Data Source Module, which defines ways to fetch and map data into OHIF's native format, covering built-in sources like dicomweb and dicomjson, and explaining how to create custom data sources for proprietary backends. --- # Module: Data Source diff --git a/platform/docs/docs/platform/extensions/modules/hpModule.md b/platform/docs/docs/platform/extensions/modules/hpModule.md index 8920ccc25..1fb26c3a6 100644 --- a/platform/docs/docs/platform/extensions/modules/hpModule.md +++ b/platform/docs/docs/platform/extensions/modules/hpModule.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Hanging Protocol +title: Hanging Protocol Module +summary: Documentation for OHIF Hanging Protocol Module, which controls image arrangement in viewports based on matching rules, with capabilities for layout configuration, viewport settings, synchronization, and advanced study comparison workflows. --- # Module: Hanging Protocol diff --git a/platform/docs/docs/platform/extensions/modules/layout-template.md b/platform/docs/docs/platform/extensions/modules/layout-template.md index 821444975..f5d1fcfdd 100644 --- a/platform/docs/docs/platform/extensions/modules/layout-template.md +++ b/platform/docs/docs/platform/extensions/modules/layout-template.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: Layout Template +title: Layout Template Module +summary: Documentation for OHIF Layout Template Module, which defines the structural organization of the viewer interface, controlling toolbar positioning, panel arrangement, and viewport grid placement through React components. --- # Module: Layout Template diff --git a/platform/docs/docs/platform/extensions/modules/panel.md b/platform/docs/docs/platform/extensions/modules/panel.md index 9a9235cee..2b48ebd4f 100644 --- a/platform/docs/docs/platform/extensions/modules/panel.md +++ b/platform/docs/docs/platform/extensions/modules/panel.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Panel +title: Panel Module +summary: Documentation for OHIF Panel Module, which provides UI components for the application's side panels, allowing extensions to contribute content that appears in left and right sidebars with proper event triggering and state management. --- # Module: Panel diff --git a/platform/docs/docs/platform/extensions/modules/sop-class-handler.md b/platform/docs/docs/platform/extensions/modules/sop-class-handler.md index cf70fb42f..5d8757e57 100644 --- a/platform/docs/docs/platform/extensions/modules/sop-class-handler.md +++ b/platform/docs/docs/platform/extensions/modules/sop-class-handler.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: SOP Class Handler +title: SOP Class Handler Module +summary: Documentation for OHIF SOP Class Handler Module, which processes specific DICOM SOP classes into displayable sets, supporting various medical imaging formats and defining how different types of DICOM data are prepared for viewing. --- # Module: SOP Class Handler diff --git a/platform/docs/docs/platform/extensions/modules/toolbar.md b/platform/docs/docs/platform/extensions/modules/toolbar.md index 6d772b930..63197d6b2 100644 --- a/platform/docs/docs/platform/extensions/modules/toolbar.md +++ b/platform/docs/docs/platform/extensions/modules/toolbar.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Toolbar +title: Toolbar Module +summary: Documentation for OHIF Toolbar Module, which provides UI components and evaluators for the application's toolbar, supporting custom button types, advanced state management, and conditional rendering based on viewport and modality requirements. --- # Module: Toolbar diff --git a/platform/docs/docs/platform/extensions/modules/utility.md b/platform/docs/docs/platform/extensions/modules/utility.md index fbb975d1a..bc44a9f9c 100644 --- a/platform/docs/docs/platform/extensions/modules/utility.md +++ b/platform/docs/docs/platform/extensions/modules/utility.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: Utility +title: Utility Module +summary: Documentation for OHIF Utility Module, which exposes reusable functionality from one extension to others, allowing for sharing of internal methods, services, and enumerations across the application architecture. --- # Module: Utility diff --git a/platform/docs/docs/platform/extensions/modules/viewport.md b/platform/docs/docs/platform/extensions/modules/viewport.md index b64a13e33..782594c07 100644 --- a/platform/docs/docs/platform/extensions/modules/viewport.md +++ b/platform/docs/docs/platform/extensions/modules/viewport.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Viewport +title: Viewport Module +summary: Documentation for OHIF Viewport Module, which provides React components that consume displaySets for viewing medical images and documents, with examples of 2D image viewing, structured reports, PDFs, and performance optimization techniques. --- # Module: Viewport diff --git a/platform/docs/docs/platform/internationalization.md b/platform/docs/docs/platform/internationalization.md index 8caf9a729..c849f6fde 100644 --- a/platform/docs/docs/platform/internationalization.md +++ b/platform/docs/docs/platform/internationalization.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Internationalization +title: Internationalization +summary: Documentation of OHIF's internationalization (i18n) implementation, including how to change languages, extend existing languages, add new languages, and contribute translations, using the @ohif/i18n package powered by i18next. --- # Viewer: Internationalization diff --git a/platform/docs/docs/platform/managers/commands.md b/platform/docs/docs/platform/managers/commands.md index 8727f9893..bb5957bd1 100644 --- a/platform/docs/docs/platform/managers/commands.md +++ b/platform/docs/docs/platform/managers/commands.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Commands Manager +title: Commands Manager +summary: Documentation for the CommandsManager class which tracks named functions scoped to specific contexts, allowing OHIF to execute commands with appropriate context prioritization across the application. --- # Commands Manager diff --git a/platform/docs/docs/platform/managers/extension.md b/platform/docs/docs/platform/managers/extension.md index a31f22442..69e566850 100644 --- a/platform/docs/docs/platform/managers/extension.md +++ b/platform/docs/docs/platform/managers/extension.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Extension Manager +title: Extension Manager +summary: Documentation for the ExtensionManager class which aggregates and exposes extension modules throughout the OHIF application, manages data sources, and provides a centralized registry for accessing extension functionality. --- # Extension Manager diff --git a/platform/docs/docs/platform/managers/hotkeys.md b/platform/docs/docs/platform/managers/hotkeys.md index 75d4ead30..81b54f2d8 100644 --- a/platform/docs/docs/platform/managers/hotkeys.md +++ b/platform/docs/docs/platform/managers/hotkeys.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Hotkeys Manager +title: Hotkeys Manager +summary: Documentation for the HotkeysManager class which handles keyboard shortcut bindings to commands, allowing configuration of global and mode-specific keyboard shortcuts with user customization capabilities. --- # Hotkeys Managers diff --git a/platform/docs/docs/platform/managers/index.md b/platform/docs/docs/platform/managers/index.md index ee6d6b2fc..7638a0bd8 100644 --- a/platform/docs/docs/platform/managers/index.md +++ b/platform/docs/docs/platform/managers/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: Managers Introduction +summary: Overview of OHIF's manager system, which handles critical application infrastructure including extension registration, service management, command execution, and hotkey binding to coordinate functionality across the platform. --- # Managers diff --git a/platform/docs/docs/platform/managers/service.md b/platform/docs/docs/platform/managers/service.md index d9269e46c..9e185f225 100644 --- a/platform/docs/docs/platform/managers/service.md +++ b/platform/docs/docs/platform/managers/service.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Service Manager +title: Service Manager +summary: Documentation for the ServicesManager class which provides central registration and access to application services, with details on built-in services, service architecture, lifecycle management, and implementation of custom services. --- # Services Manager diff --git a/platform/docs/docs/platform/modes/index.md b/platform/docs/docs/platform/modes/index.md index aded22bd0..7fdd3e39a 100644 --- a/platform/docs/docs/platform/modes/index.md +++ b/platform/docs/docs/platform/modes/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: Modes Introduction +summary: Overview of OHIF Modes, which are specialized viewer configurations for specific clinical workflows, allowing multiple purpose-specific applications to coexist within a single OHIF deployment. --- # Modes diff --git a/platform/docs/docs/platform/modes/installation.md b/platform/docs/docs/platform/modes/installation.md index 08c456d29..20af3d0b2 100644 --- a/platform/docs/docs/platform/modes/installation.md +++ b/platform/docs/docs/platform/modes/installation.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Installation +title: Mode Installation +summary: Documentation for installing OHIF Modes, including how to use the OHIF CLI to add both local and NPM-published modes to extend the viewer with custom clinical workflows. --- # Modes: Installation diff --git a/platform/docs/docs/platform/modes/lifecycle.md b/platform/docs/docs/platform/modes/lifecycle.md index 8c0ec41ce..c3bd0e707 100644 --- a/platform/docs/docs/platform/modes/lifecycle.md +++ b/platform/docs/docs/platform/modes/lifecycle.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Lifecycle Hooks +title: Mode Lifecycle Hooks +summary: Documentation for OHIF Mode's lifecycle hooks (onModeInit, onModeEnter, and onModeExit), which allow customization of initialization, resource setup, and cleanup when entering or exiting viewer modes. --- # Modes: Lifecycle Hooks diff --git a/platform/docs/docs/platform/modes/routes.md b/platform/docs/docs/platform/modes/routes.md index 5a3bdc6f3..1668142ee 100644 --- a/platform/docs/docs/platform/modes/routes.md +++ b/platform/docs/docs/platform/modes/routes.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Routes +title: Mode Routes +summary: Documentation for OHIF Mode routes, which define URL paths, initialization logic, and layout templates for specific viewer workflows, allowing multiple modes to coexist within a single application. --- # Mode: Routes diff --git a/platform/docs/docs/platform/modes/validity.md b/platform/docs/docs/platform/modes/validity.md index e3f70af76..f95421b80 100644 --- a/platform/docs/docs/platform/modes/validity.md +++ b/platform/docs/docs/platform/modes/validity.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Validity +title: Mode Validity +summary: Documentation for OHIF Mode validity checks, which determine when specific modes should be available for particular studies based on modalities, tags, or custom logic to ensure appropriate workflows for different types of imaging studies. --- # Mode: Validity diff --git a/platform/docs/docs/platform/pwa-vs-packaged.md b/platform/docs/docs/platform/pwa-vs-packaged.md index bdc411e6c..0e6c4ebb0 100644 --- a/platform/docs/docs/platform/pwa-vs-packaged.md +++ b/platform/docs/docs/platform/pwa-vs-packaged.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: PWA vs Packaged Application +summary: Explanation of OHIF's primary build process for Progressive Web Applications (PWAs), detailing how the application is built as a set of static assets with service worker support for enhanced performance across devices and network conditions. --- # PWA vs Packaged diff --git a/platform/docs/docs/platform/scope-of-project.md b/platform/docs/docs/platform/scope-of-project.md index 95460e4bc..089803c40 100644 --- a/platform/docs/docs/platform/scope-of-project.md +++ b/platform/docs/docs/platform/scope-of-project.md @@ -1,5 +1,7 @@ --- sidebar_position: 1 +title: Scope of Project +summary: Overview of the OHIF Viewer's scope as a web-based medical imaging viewer that functions as a "dumb client," explaining its capabilities as a Progressive Web Application (PWA), the separation of data from the viewer, and clarification about offline capabilities. --- # Scope of Project diff --git a/platform/docs/docs/platform/services/customization-service/Measurements.md b/platform/docs/docs/platform/services/customization-service/Measurements.md index 7d8a69801..2558e1f0a 100644 --- a/platform/docs/docs/platform/services/customization-service/Measurements.md +++ b/platform/docs/docs/platform/services/customization-service/Measurements.md @@ -1,5 +1,7 @@ --- -title: Measurements +title: Measurements Customization +summary: Documentation for customizing OHIF's measurement tools and displays, including how to modify display formats, annotation behaviors, and tracking interfaces for medical imaging measurements. +sidebar_position: 4 --- diff --git a/platform/docs/docs/platform/services/customization-service/Segmentation.md b/platform/docs/docs/platform/services/customization-service/Segmentation.md index 7953b39b3..c363ab365 100644 --- a/platform/docs/docs/platform/services/customization-service/Segmentation.md +++ b/platform/docs/docs/platform/services/customization-service/Segmentation.md @@ -1,5 +1,7 @@ --- -title: Segmentation +title: Segmentation Customization +summary: Documentation for customizing OHIF's segmentation tools and visualization options, including configuration for segment rendering, color schemes, and interaction behaviors for medical image segmentation workflows. +sidebar_position: 5 --- diff --git a/platform/docs/docs/platform/services/customization-service/StudyBrowser.md b/platform/docs/docs/platform/services/customization-service/StudyBrowser.md index fbbf3830e..30d65bbdc 100644 --- a/platform/docs/docs/platform/services/customization-service/StudyBrowser.md +++ b/platform/docs/docs/platform/services/customization-service/StudyBrowser.md @@ -1,5 +1,7 @@ --- -title: Study Browser +title: Study Browser Customization +summary: Documentation for customizing OHIF's Study Browser component, including configuration options for thumbnails, sorting functions, and display formats to enhance study navigation and selection workflows. +sidebar_position: 6 --- # Study Browser diff --git a/platform/docs/docs/platform/services/customization-service/advanced.md b/platform/docs/docs/platform/services/customization-service/advanced.md index 7efe64df9..6f14b76c4 100644 --- a/platform/docs/docs/platform/services/customization-service/advanced.md +++ b/platform/docs/docs/platform/services/customization-service/advanced.md @@ -1,5 +1,7 @@ --- title: Advanced Customization +summary: Documentation for advanced OHIF customization techniques, including inheritance patterns, transform functions, and dynamic assembly of customizations to create sophisticated configurations across the platform. +sidebar_position: 8 --- diff --git a/platform/docs/docs/platform/services/customization-service/contextMenu.md b/platform/docs/docs/platform/services/customization-service/contextMenu.md index 345531087..278bdb749 100644 --- a/platform/docs/docs/platform/services/customization-service/contextMenu.md +++ b/platform/docs/docs/platform/services/customization-service/contextMenu.md @@ -1,6 +1,8 @@ --- sidebar_label: Context Menu sidebar_position: 3 +title: Context Menu Customization +summary: Documentation for customizing OHIF's context menus, including defining menu structures and click interactions specific to different contexts like the Cornerstone viewport. --- # Context Menu diff --git a/platform/docs/docs/platform/services/customization-service/customRoutes.md b/platform/docs/docs/platform/services/customization-service/customRoutes.md index cc52cae6c..24134dc0d 100644 --- a/platform/docs/docs/platform/services/customization-service/customRoutes.md +++ b/platform/docs/docs/platform/services/customization-service/customRoutes.md @@ -1,6 +1,8 @@ --- sidebar_label: Custom Routes sidebar_position: 2 +title: Custom Routes +summary: Documentation for creating custom routes in OHIF, allowing extensions to define new URL paths and React components to extend the application with additional pages and navigation options. --- # customRoutes diff --git a/platform/docs/docs/platform/services/customization-service/customizationService.md b/platform/docs/docs/platform/services/customization-service/customizationService.md index afb57f2ff..b8284785f 100644 --- a/platform/docs/docs/platform/services/customization-service/customizationService.md +++ b/platform/docs/docs/platform/services/customization-service/customizationService.md @@ -1,6 +1,8 @@ --- sidebar_label: Introduction sidebar_position: 1 +title: Customization Service +summary: Documentation for OHIF's Customization Service, which provides a flexible framework for configuring and overriding viewer components across different scopes (default, mode, global), supporting dynamic customization of UI elements and behaviors. --- import { customizations, TableGenerator } from './sampleCustomizations'; diff --git a/platform/docs/docs/platform/services/customization-service/viewportOverlay.md b/platform/docs/docs/platform/services/customization-service/viewportOverlay.md index 4804617b9..68af62c1c 100644 --- a/platform/docs/docs/platform/services/customization-service/viewportOverlay.md +++ b/platform/docs/docs/platform/services/customization-service/viewportOverlay.md @@ -1,5 +1,8 @@ --- +sidebar_label: Viewport Overlay sidebar_position: 1 +title: Viewport Overlay Customization +summary: Documentation for customizing OHIF's viewport overlays, allowing configuration of the information displayed in each corner (top-right, top-left, bottom-left, bottom-right) of medical imaging viewports. --- import { viewportOverlayCustomizations , TableGenerator } from './sampleCustomizations'; diff --git a/platform/docs/docs/platform/services/data/DicomMetadataStore.md b/platform/docs/docs/platform/services/data/DicomMetadataStore.md index 927b8b8e5..841be46f7 100644 --- a/platform/docs/docs/platform/services/data/DicomMetadataStore.md +++ b/platform/docs/docs/platform/services/data/DicomMetadataStore.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: DICOM Metadata Store +title: DICOM Metadata Store +summary: Documentation for OHIF's DicomMetadataStore service, which provides centralized storage and retrieval functions for DICOM metadata with hierarchical organization of studies, series, and instances. --- # DICOM Metadata Store diff --git a/platform/docs/docs/platform/services/data/DisplaySetService.md b/platform/docs/docs/platform/services/data/DisplaySetService.md index af4e36f69..3ed57273d 100644 --- a/platform/docs/docs/platform/services/data/DisplaySetService.md +++ b/platform/docs/docs/platform/services/data/DisplaySetService.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: DisplaySet Service +title: DisplaySet Service +summary: Documentation for OHIF's DisplaySetService, which converts instance metadata into displayable sets for visualization, allowing dynamic creation, updating, and management of display sets from various data sources. --- # DisplaySet Service diff --git a/platform/docs/docs/platform/services/data/HangingProtocolService.md b/platform/docs/docs/platform/services/data/HangingProtocolService.md index de33e9bbd..d12920e66 100644 --- a/platform/docs/docs/platform/services/data/HangingProtocolService.md +++ b/platform/docs/docs/platform/services/data/HangingProtocolService.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Hanging Protocol Service +title: Hanging Protocol Service +summary: Documentation for OHIF's HangingProtocolService, which manages the automatic arrangement of medical images in viewports based on matching criteria, with support for custom attributes, synchronization, and display set selection. --- # Hanging Protocol Service diff --git a/platform/docs/docs/platform/services/data/MeasurementService.md b/platform/docs/docs/platform/services/data/MeasurementService.md index f5ede2f14..92bbb7dd5 100644 --- a/platform/docs/docs/platform/services/data/MeasurementService.md +++ b/platform/docs/docs/platform/services/data/MeasurementService.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Measurement Service +title: Measurement Service +summary: Documentation for OHIF's MeasurementService, which handles annotation representation with extensible sources and mappers, supporting various measurement tools and allowing custom implementations beyond the built-in CornerstoneTools integration. --- # Measurement Service diff --git a/platform/docs/docs/platform/services/data/MultiMonitorService.md b/platform/docs/docs/platform/services/data/MultiMonitorService.md index eb74d28af..85664af46 100644 --- a/platform/docs/docs/platform/services/data/MultiMonitorService.md +++ b/platform/docs/docs/platform/services/data/MultiMonitorService.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Multi Monitor Service +title: Multi Monitor Service +summary: Documentation for OHIF's MultiMonitorService, which provides basic support for opening and managing multiple viewer windows, including split-screen options and cross-window communication capabilities. --- diff --git a/platform/docs/docs/platform/services/data/PanelService.md b/platform/docs/docs/platform/services/data/PanelService.md index b0a530b85..d3bd7bca3 100644 --- a/platform/docs/docs/platform/services/data/PanelService.md +++ b/platform/docs/docs/platform/services/data/PanelService.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Panel Service +title: Panel Service +summary: Documentation for OHIF's PanelService, which manages the activation and display of side panels registered via extension modules, with support for explicit activation or event-triggered display of panels. --- # Panel Service diff --git a/platform/docs/docs/platform/services/data/SegmentationService.md b/platform/docs/docs/platform/services/data/SegmentationService.md index c2eeb6080..031594862 100644 --- a/platform/docs/docs/platform/services/data/SegmentationService.md +++ b/platform/docs/docs/platform/services/data/SegmentationService.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: Segmentation Service +title: Segmentation Service +summary: Documentation for OHIF's SegmentationService, which provides tools for creating, managing, and interacting with image segmentations, including labelmap creation, segment operations, and visualization controls. --- # Segmentation Service diff --git a/platform/docs/docs/platform/services/data/SyncGroupService.md b/platform/docs/docs/platform/services/data/SyncGroupService.md index 835fd5621..13c7cb65f 100644 --- a/platform/docs/docs/platform/services/data/SyncGroupService.md +++ b/platform/docs/docs/platform/services/data/SyncGroupService.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: SyncGroup Service +title: SyncGroup Service +summary: Documentation for OHIF's SyncGroupService, which manages synchronization between multiple viewports based on various criteria like camera position, window level, and slice position, with both hanging protocol and manual configuration options. --- # Sync Group Service diff --git a/platform/docs/docs/platform/services/data/ToolGroupService.md b/platform/docs/docs/platform/services/data/ToolGroupService.md index 0d7a04cf0..37854e929 100644 --- a/platform/docs/docs/platform/services/data/ToolGroupService.md +++ b/platform/docs/docs/platform/services/data/ToolGroupService.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: ToolGroup Service +title: ToolGroup Service +summary: Documentation for OHIF's ToolGroupService, which manages tool groups and their associated tools, allowing organization and control of measurement, annotation, and manipulation tools across different viewports. --- # Tool Group Service diff --git a/platform/docs/docs/platform/services/data/ToolbarService.md b/platform/docs/docs/platform/services/data/ToolbarService.md index 3c8aff777..704e4cd2b 100644 --- a/platform/docs/docs/platform/services/data/ToolbarService.md +++ b/platform/docs/docs/platform/services/data/ToolbarService.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Toolbar Service +title: Toolbar Service +summary: Documentation for OHIF's ToolbarService, which manages the viewer's toolbar UI components, including button creation, section organization, and command execution, with support for nested dropdowns and state management. --- # Toolbar **Service** diff --git a/platform/docs/docs/platform/services/data/WorkflowStepService.md b/platform/docs/docs/platform/services/data/WorkflowStepService.md index 7070cade4..68ae609ed 100644 --- a/platform/docs/docs/platform/services/data/WorkflowStepService.md +++ b/platform/docs/docs/platform/services/data/WorkflowStepService.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: WorkflowStep Service +title: WorkflowStep Service +summary: Documentation for OHIF's WorkflowStepService, which enables structured multi-step clinical workflows with customizable hanging protocols, layouts, and toolbars for each step, providing guided navigation through complex imaging tasks. --- # Workflow Step Service diff --git a/platform/docs/docs/platform/services/data/index.md b/platform/docs/docs/platform/services/data/index.md index 3253ba9ee..6a30a6fbc 100644 --- a/platform/docs/docs/platform/services/data/index.md +++ b/platform/docs/docs/platform/services/data/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Overview +title: Data Services Overview +summary: Overview of OHIF's data services architecture, which replaced the Redux store with a more modular approach using service-specific state management and a pub/sub pattern for communication between components. --- # Overview diff --git a/platform/docs/docs/platform/services/index.md b/platform/docs/docs/platform/services/index.md index 1096ba6ff..814bd446b 100644 --- a/platform/docs/docs/platform/services/index.md +++ b/platform/docs/docs/platform/services/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: OHIF Services +summary: Overview of OHIF's services architecture, which provides modular, concern-specific code components that manage state and operations throughout the application, including both data services and UI services that follow a pub/sub pattern to reduce coupling. --- # Services diff --git a/platform/docs/docs/platform/services/pubsub.md b/platform/docs/docs/platform/services/pubsub.md index 036e592ef..b1143b655 100644 --- a/platform/docs/docs/platform/services/pubsub.md +++ b/platform/docs/docs/platform/services/pubsub.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Pub Sub +title: Publish-Subscribe Pattern +summary: Documentation of the publish-subscribe pattern implementation in OHIF, which enables event-based communication between services, allowing components to subscribe to events and receive updates when they occur, reducing direct dependencies between modules. --- # Pub sub diff --git a/platform/docs/docs/platform/services/ui/cine-service.md b/platform/docs/docs/platform/services/ui/cine-service.md index 707b5d97f..2908c02a7 100644 --- a/platform/docs/docs/platform/services/ui/cine-service.md +++ b/platform/docs/docs/platform/services/ui/cine-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: CINE Service +title: CINE Service +summary: Documentation for OHIF's CINE Service, which provides animation capabilities for scrolling through image stacks at configurable frame rates, enabling dynamic review of multi-frame image series. --- # CINE Service diff --git a/platform/docs/docs/platform/services/ui/index.md b/platform/docs/docs/platform/services/ui/index.md index 2a0203a74..ad8722033 100644 --- a/platform/docs/docs/platform/services/ui/index.md +++ b/platform/docs/docs/platform/services/ui/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Overview +title: UI Services Overview +summary: Overview of OHIF's UI services architecture, which enables consistent UI interactions across the application through React context providers and service implementations, allowing extensions to leverage components like modals, notifications, and dialogs. --- # Overview diff --git a/platform/docs/docs/platform/services/ui/ui-dialog-service.md b/platform/docs/docs/platform/services/ui/ui-dialog-service.md index 152841ae6..09d9cc542 100644 --- a/platform/docs/docs/platform/services/ui/ui-dialog-service.md +++ b/platform/docs/docs/platform/services/ui/ui-dialog-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: UI Dialog Service +title: UI Dialog Service +summary: Documentation for OHIF's UI Dialog Service, which provides streamlined dialog windows for user attention, input collection, and information display, with methods for creating and dismissing multiple dialogs throughout the application. --- # UI Dialog Service diff --git a/platform/docs/docs/platform/services/ui/ui-modal-service.md b/platform/docs/docs/platform/services/ui/ui-modal-service.md index 5fe5a643d..02512d5a6 100644 --- a/platform/docs/docs/platform/services/ui/ui-modal-service.md +++ b/platform/docs/docs/platform/services/ui/ui-modal-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: UI Modal Service +title: UI Modal Service +summary: Documentation for OHIF's UI Modal Service, which enables displaying centered, non-draggable modal windows for focused user interaction, with support for custom components and content throughout the application. --- # UI Modal Service diff --git a/platform/docs/docs/platform/services/ui/ui-notification-service.md b/platform/docs/docs/platform/services/ui/ui-notification-service.md index 815ac6d8d..5f700b58f 100644 --- a/platform/docs/docs/platform/services/ui/ui-notification-service.md +++ b/platform/docs/docs/platform/services/ui/ui-notification-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: UI Notification Service +title: UI Notification Service +summary: Documentation for OHIF's UI Notification Service, which provides a standardized way to display non-intrusive, contextual notifications for timely and relevant information to users throughout the application. --- # UI Notification Service diff --git a/platform/docs/docs/platform/services/ui/ui-viewport-dialog-service.md b/platform/docs/docs/platform/services/ui/ui-viewport-dialog-service.md index b50e3e7e4..0d95b0c14 100644 --- a/platform/docs/docs/platform/services/ui/ui-viewport-dialog-service.md +++ b/platform/docs/docs/platform/services/ui/ui-viewport-dialog-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: UI Viewport Dialog Service +title: UI Viewport Dialog Service +summary: Documentation for OHIF's UI Viewport Dialog Service, which creates modal dialogs inside specific viewports for contextual user interactions, supporting different types of messages and action buttons for user input. --- # UI Viewport Dialog Service diff --git a/platform/docs/docs/platform/services/ui/viewport-action-menu.md b/platform/docs/docs/platform/services/ui/viewport-action-menu.md index 5a0592535..84b87f5c4 100644 --- a/platform/docs/docs/platform/services/ui/viewport-action-menu.md +++ b/platform/docs/docs/platform/services/ui/viewport-action-menu.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Viewport Action Corners +title: Viewport Action Corners Service +summary: Documentation for OHIF's Viewport Action Corners Service, which manages interactive UI components placed in viewport corners, enabling flexible positioning, priority ordering, and dynamic updates of components for viewport-specific control. --- # Viewport Action Corners Service diff --git a/platform/docs/docs/platform/services/ui/viewport-grid-service.md b/platform/docs/docs/platform/services/ui/viewport-grid-service.md index 186afc419..e197cb504 100644 --- a/platform/docs/docs/platform/services/ui/viewport-grid-service.md +++ b/platform/docs/docs/platform/services/ui/viewport-grid-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Viewport Grid Service +title: Viewport Grid Service +summary: Documentation for OHIF's Viewport Grid Service, which manages the layout and configuration of the viewer's viewport grid, handling active viewport selection, display set assignment, and layout changes with event broadcasting capabilities. --- # Viewport Grid Service diff --git a/platform/docs/docs/platform/themeing.md b/platform/docs/docs/platform/themeing.md index 48a881c20..b74fe20b3 100644 --- a/platform/docs/docs/platform/themeing.md +++ b/platform/docs/docs/platform/themeing.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Theming +title: Theming the OHIF Viewer +summary: Documentation on customizing the visual appearance of the OHIF Viewer using Tailwind CSS and white-labeling capabilities, including how to modify the color scheme, add custom layouts via the LayoutTemplateModule, and replace the application logo with custom branding. --- # Viewer: Theming diff --git a/platform/docs/docs/release-notes.md b/platform/docs/docs/release-notes.md index 48491be16..6898e651e 100644 --- a/platform/docs/docs/release-notes.md +++ b/platform/docs/docs/release-notes.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Release Notes +title: OHIF Viewer Release Notes +summary: Information about OHIF Viewer version releases, including new features, improvements, and bug fixes, which can be found in detail on the official OHIF website. --- # Release Notes diff --git a/platform/docs/docs/resources.md b/platform/docs/docs/resources.md index bbdd4a18f..edcedf760 100644 --- a/platform/docs/docs/resources.md +++ b/platform/docs/docs/resources.md @@ -1,6 +1,8 @@ --- sidebar_position: 13 sidebar_label: Resources +title: OHIF Viewer Educational Resources +summary: A comprehensive collection of presentations, slides, posters, and videos from conferences, hackathons, and community meetings where the OHIF team has shared knowledge about the viewer's development, features, and capabilities, organized chronologically from 2016 to present. --- # Resources diff --git a/platform/docs/docs/test-coverage.md b/platform/docs/docs/test-coverage.md index 74d9203d7..169fed8ca 100644 --- a/platform/docs/docs/test-coverage.md +++ b/platform/docs/docs/test-coverage.md @@ -1,6 +1,8 @@ --- sidebar_position: 14 sidebar_label: Test Coverage +title: OHIF Viewer Test Coverage +summary: Information about the automated testing infrastructure for the OHIF Viewer, with a focus on Playwright tests and access to the latest test coverage reports, which help ensure reliability and quality of the codebase. --- # Test Coverage diff --git a/platform/docs/package.json b/platform/docs/package.json index ac8629cd7..78872db04 100644 --- a/platform/docs/package.json +++ b/platform/docs/package.json @@ -9,7 +9,11 @@ "start": "docusaurus start --port 8001", "dev": "docusaurus clear && docusaurus start --port 8001", "docs": "docusaurus start --port 8001", - "build": "docusaurus build", + "build": "docusaurus build && yarn run prepare-markdown-files && yarn run generate-llms-txt && yarn run generate-llms-full-txt", + "build:docs": "docusaurus build && yarn run prepare-markdown-files && yarn run generate-llms-txt && yarn run generate-llms-full-txt", + "prepare-markdown-files": "node ./scripts/prepare-markdown-files.js", + "generate-llms-txt": "node ./scripts/generate-llms-txt.js", + "generate-llms-full-txt": "node ./scripts/generate-llms-full-txt.js", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", @@ -72,6 +76,7 @@ "docusaurus-plugin-image-zoom": "^1.0.1", "file-loader": "^6.2.0", "framer-motion": "6.2.4", + "glob": "^10.3.10", "lucide-react": "^0.379.0", "next-themes": "^0.3.0", "postcss": "^8.4.47", diff --git a/platform/docs/scripts/README.md b/platform/docs/scripts/README.md new file mode 100644 index 000000000..d07997138 --- /dev/null +++ b/platform/docs/scripts/README.md @@ -0,0 +1,101 @@ +# OHIF Viewer Documentation Scripts + +This directory contains utility scripts for the OHIF Viewer documentation. + +## prepare-markdown-files.js + +This script copies all markdown files from the docs directory (excluding `api/` and `assets/`) to a `/llm` directory in the build output, making them available as static markdown files that can be accessed directly without the Docusaurus UI. + +### Purpose + +These files are made available for easy access by LLMs and other tools that need to retrieve the raw markdown content without the surrounding Docusaurus UI elements. + +### Access URLs + +After deployment, the markdown files can be accessed at URLs like: + +- `https://docs.ohif.org/llm/platform/extensions/modules/commands.md` +- `https://docs.ohif.org/llm/platform/services/ui/index.md` + +### Implementation + +The script is automatically run as part of the `build:docs` command and will: + +1. Find all markdown files in the `/platform/docs/docs/` directory (excluding api/ and assets/) +2. Copy them to `/platform/docs/build/llm/` preserving the directory structure +3. These files are then deployed to the website along with the rest of the built documentation + +You can also run this script manually with: + +```bash +cd platform/docs +yarn run prepare-markdown-files +``` + +## generate-llms-txt.js + +This script generates a llms.txt file that follows the [llms.txt specification](https://llmstxt.site) by creating an index of all the markdown files that have been copied to the `/llm` directory. + +### Purpose + +The llms.txt file provides an overview of all available documentation in a format that's optimized for use with Large Language Models (LLMs). It creates a structured index that LLMs can use to efficiently navigate and find information in the documentation. + +### Access URL + +After deployment, the llms.txt file can be accessed at: + +- `https://docs.ohif.org/llms.txt` + +### Implementation + +The script is automatically run as part of the `build:docs` command (after `prepare-markdown-files.js`) and will: + +1. Scan all the markdown files that were copied to the `/llm` directory +2. Extract titles and summaries from the frontmatter of each file +3. Organize them into sections based on their directory structure +4. Generate a single llms.txt file in the standard format with links to all the documentation files +5. Save the file to the build directory root so it will be accessible at the root of the website + +You can also run this script manually with (after running `prepare-markdown-files.js`): + +```bash +cd platform/docs +yarn run generate-llms-txt +``` + +## generate-llms-full-txt.js + +This script generates an llms-full.txt file by concatenating the content of all markdown files from the `/llm` directory into a single giant file, similar to the approach used by bun.sh. + +### Purpose + +The llms-full.txt file provides the complete content of all documentation in a single file, which can be useful for LLMs that need to search or reference the entire documentation at once. This approach allows for contextual understanding across multiple documentation pages. + +### Access URL + +After deployment, the llms-full.txt file can be accessed at: + +- `https://docs.ohif.org/llms-full.txt` + +### Implementation + +The script is automatically run as part of the `build:docs` command (after `generate-llms-txt.js`) and will: + +1. Scan all the markdown files that were copied to the `/llm` directory +2. Remove frontmatter from each file to clean up the content +3. Add clear section headers and source URLs for each file +4. Concatenate all the content into a single file with proper organization by section +5. Save the file to the build directory root so it will be accessible at the root of the website + +The output file has the following structure: +- Title and introduction for OHIF Viewer +- Files are organized by their directory structure (e.g., platform, extensions, services) +- Each file has a header with its title and source URL +- Separator lines between files for clarity + +You can also run this script manually with (after running `prepare-markdown-files.js`): + +```bash +cd platform/docs +yarn run generate-llms-full-txt +``` diff --git a/platform/docs/scripts/generate-llms-full-txt.js b/platform/docs/scripts/generate-llms-full-txt.js new file mode 100644 index 000000000..316acbdc8 --- /dev/null +++ b/platform/docs/scripts/generate-llms-full-txt.js @@ -0,0 +1,291 @@ +/** + * Script to generate an llms-full.txt file that concatenates all markdown content + * This script creates a single giant file with all markdown content from the /llm directory + * with proper heading hierarchy preserved + */ + +const fs = require('fs'); +const path = require('path'); +const { glob } = require('glob'); + +// Base docs directory +const baseDocsDir = path.join(__dirname, '../docs'); +// Output directory for LLM markdown files +const llmDir = path.join(__dirname, '../build/llm'); +// Output file path for llms-full.txt +const outputFilePath = path.join(__dirname, '../build/llms-full.txt'); + +// Get all subdirectories to create sections +async function getDirectorySections() { + const directories = new Set(); + + // Find all subdirectories that contain markdown files + const markdownFiles = await glob(`${llmDir}/**/*.md`); + + markdownFiles.forEach((filePath) => { + // Get the relative directory from the llm dir + const relativePath = path.relative(llmDir, filePath); + const dirPath = path.dirname(relativePath); + + // Add to set if it's not in the root + if (dirPath !== '.') { + // Get the top-level directory + const topDir = dirPath.split(path.sep)[0]; + directories.add(topDir); + } + }); + + return Array.from(directories).sort(); +} + +// Get all subdirectories for a section +async function getSubdirectories(section) { + const sectionPath = path.join(llmDir, section); + const subdirectories = new Set(); + + // Find all markdown files in this section + const markdownFiles = await glob(`${sectionPath}/**/*.md`); + + markdownFiles.forEach((filePath) => { + // Get the relative directory from the section path + const relativePath = path.relative(sectionPath, filePath); + const dirPath = path.dirname(relativePath); + + // Add to set if it's not in the root + if (dirPath !== '.') { + subdirectories.add(dirPath); + } + }); + + return Array.from(subdirectories).sort(); +} + +// Process content to adjust heading levels +function adjustHeadingLevels(content, baseLevel) { + // Replace headings with adjusted levels while limiting max depth to h4 + let processedContent = content; + + // Process all heading levels from h1 to h6 + for (let i = 1; i <= 6; i++) { + // Limit maximum heading level to h4 + const newLevel = Math.min(i + baseLevel, 4); + const pattern = new RegExp(`^(#{${i}})\\s+(.+)$`, 'gm'); + processedContent = processedContent.replace(pattern, `${'#'.repeat(newLevel)} $2`); + } + + return processedContent; +} + +// Process a single markdown file +function processMarkdownFile(filePath, baseLevel) { + // Read the file content + const content = fs.readFileSync(filePath, 'utf8'); + + // Process content to remove frontmatter + let processedContent = content; + const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---\n/); + if (frontmatterMatch) { + processedContent = content.replace(/^---\n[\s\S]*?\n---\n/, ''); + } + + // Adjust heading levels + processedContent = adjustHeadingLevels(processedContent, baseLevel); + + return processedContent; +} + +// Process all files in a subsection +async function processSubsectionFiles(section, subsection) { + const subsectionPath = path.join(llmDir, section, subsection); + const subsectionContent = []; + + // Get all markdown files for this subsection + const markdownFiles = await glob(`${subsectionPath}/*.md`); + + // Sort files alphabetically + markdownFiles.sort(); + + for (const filePath of markdownFiles) { + // Get the file name + const fileName = path.basename(filePath, '.md'); + const relativePath = path.relative(llmDir, filePath); + + // Extract title from frontmatter or filename + const content = fs.readFileSync(filePath, 'utf8'); + let title = ''; + const frontmatterTitleMatch = content.match(/title:\s*([^\n]+)/); + const firstHeadingMatch = content.match(/# ([^\n]+)/); + + if (frontmatterTitleMatch) { + title = frontmatterTitleMatch[1].trim(); + // Remove quotes if present + title = title.replace(/^["'](.*)["']$/, '$1'); + } else if (firstHeadingMatch) { + title = firstHeadingMatch[1].trim(); + } else { + // Use filename as fallback + title = fileName; + } + + // Add file header (as h3, since section is h1 and subsection is h2) + subsectionContent.push(`\n\n### ${title}\n`); + subsectionContent.push(`Source: https://docs.ohif.org/llm/${relativePath}\n`); + + // Process the file content with adjusted heading levels (h1->h4, h2->h5, etc.) + const processedContent = processMarkdownFile(filePath, 3); + subsectionContent.push(processedContent); + + // Add separator + subsectionContent.push('\n\n---\n'); + } + + return subsectionContent.join('\n'); +} + +// Process files directly in the section root (not in subsections) +async function processSectionRootFiles(section) { + const sectionPath = path.join(llmDir, section); + const sectionContent = []; + + // Get all markdown files directly in the section root + const markdownFiles = await glob(`${sectionPath}/*.md`); + + // Sort files alphabetically + markdownFiles.sort(); + + for (const filePath of markdownFiles) { + // Get the file name + const fileName = path.basename(filePath, '.md'); + const relativePath = path.relative(llmDir, filePath); + + // Extract title from frontmatter or filename + const content = fs.readFileSync(filePath, 'utf8'); + let title = ''; + const frontmatterTitleMatch = content.match(/title:\s*([^\n]+)/); + const firstHeadingMatch = content.match(/# ([^\n]+)/); + + if (frontmatterTitleMatch) { + title = frontmatterTitleMatch[1].trim(); + // Remove quotes if present + title = title.replace(/^["'](.*)["']$/, '$1'); + } else if (firstHeadingMatch) { + title = firstHeadingMatch[1].trim(); + } else { + // Use filename as fallback + title = fileName; + } + + // Add file header (as h2, since section is h1) + sectionContent.push(`\n\n## ${title}\n`); + sectionContent.push(`Source: https://docs.ohif.org/llm/${relativePath}\n`); + + // Process the file content with adjusted heading levels (h1->h3, h2->h4, etc.) + const processedContent = processMarkdownFile(filePath, 2); + sectionContent.push(processedContent); + + // Add separator + sectionContent.push('\n\n---\n'); + } + + return sectionContent.join('\n'); +} + +// Process root files +async function processRootFiles() { + const rootContent = []; + + // Get all markdown files in the root directory + const rootFiles = await glob(`${llmDir}/*.md`); + + // Sort files alphabetically + rootFiles.sort(); + + for (const filePath of rootFiles) { + // Get the file name + const fileName = path.basename(filePath, '.md'); + + // Extract title from frontmatter or filename + const content = fs.readFileSync(filePath, 'utf8'); + let title = ''; + const frontmatterTitleMatch = content.match(/title:\s*([^\n]+)/); + const firstHeadingMatch = content.match(/# ([^\n]+)/); + + if (frontmatterTitleMatch) { + title = frontmatterTitleMatch[1].trim(); + // Remove quotes if present + title = title.replace(/^["'](.*)["']$/, '$1'); + } else if (firstHeadingMatch) { + title = firstHeadingMatch[1].trim(); + } else { + // Use filename as fallback + title = fileName; + } + + // Add file header (as h2, since root is h1) + rootContent.push(`\n\n## ${title}\n`); + rootContent.push(`Source: https://docs.ohif.org/llm/${fileName}\n`); + + // Process the file content with adjusted heading levels (h1->h3, h2->h4, etc.) + const processedContent = processMarkdownFile(filePath, 2); + rootContent.push(processedContent); + + // Add separator + rootContent.push('\n\n---\n'); + } + + return rootContent.join('\n'); +} + +// Generate the full concatenated content +async function generateLlmsFullTxt() { + let content = ''; + + // Add title and introduction + content += '# OHIF Documentation\n\n'; + + content += '> OHIF (Open Health Imaging Foundation) Viewer is an open-source, web-based, zero-footprint DICOM viewer platform designed for medical imaging. It provides a highly configurable and extensible framework for building diagnostic quality medical imaging applications. OHIF Viewer supports various imaging formats (primarily DICOM), offers advanced visualization tools, customizable workflows, and integration capabilities with different data sources.\n\n'; + + content += 'This file contains the complete documentation for OHIF Viewer, concatenated for easy reference and searching. Each section is clearly marked with its source URL.\n\n'; + + // Process root files first (if any) + const rootFiles = await glob(`${llmDir}/*.md`); + if (rootFiles.length > 0) { + content += '# Root Documentation\n\n'; + + // Process root files + const rootContent = await processRootFiles(); + content += rootContent; + } + + // Get all sections + const sections = await getDirectorySections(); + + // Process each section + for (const section of sections) { + // Add section header (as h1) + content += `\n\n# ${section.charAt(0).toUpperCase() + section.slice(1)}\n\n`; + + // Process files directly in the section root + const sectionRootContent = await processSectionRootFiles(section); + content += sectionRootContent; + + // Process subsections if any + const subsections = await getSubdirectories(section); + + for (const subsection of subsections) { + // Add subsection header (as h2) + content += `\n\n## ${subsection.charAt(0).toUpperCase() + subsection.slice(1)}\n\n`; + + // Process files in this subsection + const subsectionContent = await processSubsectionFiles(section, subsection); + content += subsectionContent; + } + } + + // Write the llms-full.txt file + fs.writeFileSync(outputFilePath, content); + console.log(`Generated llms-full.txt file at ${outputFilePath}`); +} + +// Run the script +generateLlmsFullTxt(); diff --git a/platform/docs/scripts/generate-llms-txt.js b/platform/docs/scripts/generate-llms-txt.js new file mode 100644 index 000000000..d9a47b693 --- /dev/null +++ b/platform/docs/scripts/generate-llms-txt.js @@ -0,0 +1,142 @@ +/** + * Script to generate an llms.txt file following the specification + * This script generates a single llms.txt file in the build directory + * with links to all the markdown files that have been copied to the /llm directory + */ + +const fs = require('fs'); +const path = require('path'); +const { glob } = require('glob'); + +// Base docs directory +const baseDocsDir = path.join(__dirname, '../docs'); +// Output directory for LLM markdown files +const llmDir = path.join(__dirname, '../build/llm'); +// Output file path for llms.txt +const outputFilePath = path.join(__dirname, '../build/llms.txt'); + +// Get all subdirectories to create sections +async function getDirectorySections() { + const directories = new Set(); + + // Find all subdirectories that contain markdown files + const markdownFiles = await glob(`${llmDir}/**/*.md`); + + markdownFiles.forEach((filePath) => { + // Get the relative directory from the llm dir + const relativePath = path.relative(llmDir, filePath); + const dirPath = path.dirname(relativePath); + + // Add to set if it's not in the root + if (dirPath !== '.') { + // Get the top-level directory + const topDir = dirPath.split(path.sep)[0]; + directories.add(topDir); + } + }); + + return Array.from(directories).sort(); +} + +// Generate links for a specific section +async function generateSectionLinks(section) { + const sectionPath = path.join(llmDir, section); + const links = []; + + // Get all markdown files for this section + const markdownFiles = await glob(`${sectionPath}/**/*.md`); + + for (const filePath of markdownFiles) { + // Get the relative path from the llm dir + const relativePath = path.relative(llmDir, filePath); + + // Read the file to extract title + const content = fs.readFileSync(filePath, 'utf8'); + + // Try to extract title from frontmatter or first heading + let title = ''; + const frontmatterTitleMatch = content.match(/title:\s*([^\n]+)/); + const firstHeadingMatch = content.match(/# ([^\n]+)/); + + if (frontmatterTitleMatch) { + title = frontmatterTitleMatch[1].trim(); + // Remove quotes if present + title = title.replace(/^["'](.*)["']$/, '$1'); + } else if (firstHeadingMatch) { + title = firstHeadingMatch[1].trim(); + } else { + // Use filename as fallback + title = path.basename(filePath, '.md'); + } + + // Get summary from frontmatter if available + let summary = ''; + const summaryMatch = content.match(/summary:\s*([^\n]+)/); + if (summaryMatch) { + summary = summaryMatch[1].trim(); + // Remove quotes if present + summary = summary.replace(/^["'](.*)["']$/, '$1'); + } + + // Create URL for the file (relative to site root) + const url = `/llm/${relativePath}`; + + // Add to links + links.push({ + title, + url, + summary, + }); + } + + return links.sort((a, b) => a.title.localeCompare(b.title)); +} + +// Generate the full llms.txt content +async function generateLlmsTxt() { + let content = ''; + + // Add title + content += '# OHIF Viewer\n\n'; + + // Add description blockquote + content += + '> OHIF (Open Health Imaging Foundation) Viewer is an open-source, web-based, zero-footprint DICOM viewer platform designed for medical imaging. It provides a highly configurable and extensible framework for building diagnostic quality medical imaging applications. OHIF Viewer supports various imaging formats (primarily DICOM), offers advanced visualization tools, customizable workflows, and integration capabilities with different data sources.\n\n'; + + // Add general information + content += + 'The OHIF Viewer is built with a modular architecture that includes extensions, modes, and services. It leverages Cornerstone3D for rendering capabilities and provides a comprehensive framework for building medical imaging applications with features like hanging protocols, segmentation, measurements, and advanced visualization tools.\n\n'; + content += 'The documentation is organized into the following sections:\n\n'; + + // Get all sections + const sections = await getDirectorySections(); + + // Process each section + for (const section of sections) { + // Get all links for this section + const links = await generateSectionLinks(section); + + if (links.length > 0) { + // Add section header + content += `## ${section.charAt(0).toUpperCase() + section.slice(1)}\n\n`; + + // Add links for this section + for (const link of links) { + content += `- [${link.title}](https://docs.ohif.org${link.url})`; + if (link.summary) { + content += `: ${link.summary}`; + } + content += '\n'; + } + + content += '\n'; + } + } + + // Write the llms.txt file + fs.writeFileSync(outputFilePath, content); + console.log(`Generated llms.txt file at ${outputFilePath}`); +} + +// Run the script +generateLlmsTxt(); diff --git a/platform/docs/scripts/prepare-markdown-files.js b/platform/docs/scripts/prepare-markdown-files.js new file mode 100644 index 000000000..c1990f566 --- /dev/null +++ b/platform/docs/scripts/prepare-markdown-files.js @@ -0,0 +1,67 @@ +/** + * Script to copy and prepare markdown files for static hosting + * This script copies all markdown files from the docs directory (excluding api and assets) + * to a /llm directory where they can be accessed directly without Docusaurus rendering + */ + +const fs = require('fs'); +const path = require('path'); +const { glob } = require('glob'); + +// Base docs directory +const baseDocsDir = path.join(__dirname, '../docs'); +// Output directory for LLM markdown files +const outputDir = path.join(__dirname, '../build/llm'); + +// Create the output directory structure +function createDirectoryIfNotExists(directoryPath) { + if (!fs.existsSync(directoryPath)) { + fs.mkdirSync(directoryPath, { recursive: true }); + } +} + +// Process a markdown file +function processMarkdownFile(filePath) { + try { + // Read the content of the markdown file + const content = fs.readFileSync(filePath, 'utf8'); + + // Get the relative path from baseDocsDir + const relativePath = path.relative(baseDocsDir, filePath); + + // Determine the output directory + const outputFilePath = path.join(outputDir, relativePath); + const outputFileDir = path.dirname(outputFilePath); + + // Create the directory if it doesn't exist + createDirectoryIfNotExists(outputFileDir); + + // Write the content to the new location + fs.writeFileSync(outputFilePath, content); + + console.log(`Processed: ${relativePath}`); + } catch (error) { + console.error(`Error processing file ${filePath}:`, error); + } +} + +// Main function +async function prepareMarkdownFiles() { + // Create the base output directory + createDirectoryIfNotExists(outputDir); + + // Find all markdown files in the docs directory + const markdownFiles = await glob(`${baseDocsDir}/**/*.md`, { + ignore: [`${baseDocsDir}/api/**/*.md`, `${baseDocsDir}/assets/**/*.md`], + }); + + console.log(`Found ${markdownFiles.length} markdown files to process.`); + + // Process each markdown file + markdownFiles.forEach(processMarkdownFile); + + console.log('Markdown file preparation complete.'); +} + +// Run the script +prepareMarkdownFiles();