docs: add llm txt (#5009)
This commit is contained in:
1 parent
4732e8093e
commit
4e185e4b21
149 files changed
+865
-7
No files matched your search
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
Reference in new issue
Block a user