docs: concept docs #25

sedghi · 2022-03-28T21:51:23Z

No description provided.

swederik

Made some comments, will try to fix the critical ones myself before merging it

swederik · 2022-03-30T04:33:09Z

packages/demo/src/helpers/createImageIdsAndCacheMetaData.js

@@ -81,6 +81,9 @@ export default async function createImageIdsAndCacheMetaData({
        instanceMetaData
      )
    }
+
+    console.debug(instanceMetaData)


swederik · 2022-03-30T04:34:06Z

packages/docs/docs/concepts/cornerstone-core/cahce.md

@@ -17,36 +17,32 @@ The cache has two main components: a volatile portion for images and a non-volat
 - When you allocate volumes, these are non-volatile and reserve a block of memory from the cache. Volumes must be released manually.


-## Decaching


Cache.md filename is wrong

swederik · 2022-03-30T06:39:51Z

packages/docs/docs/concepts/cornerstone-core/renderingEngine.md

+```js
+PublicViewportInput = {
+  /** HTML element in the DOM */
+  element: HTMLElement


Should we require a div?

yes swith to HTMLDivElement

swederik · 2022-03-30T06:41:33Z

packages/docs/docs/concepts/cornerstone-core/requestPoolManager.md

 jobs. They are separated and executed asynchronously from one another, allowing
 each retrieval request to be initiated instantly upon the availability of a request firing slot.

-Splitting the image retrieval request and decoding is enabled by default in `Cornerstone` when using the `Cornerstone-wado-image-loader` version `v4.0.0-rc` or above.
+Splitting the image retrieval request and decoding is enabled by default `Cornerstone-wado-image-loader` version `v4.0.0-rc` or above.


Maybe we should remove the -rc

swederik · 2022-03-30T06:45:16Z

packages/docs/docs/concepts/designConsiderations.md

 which leverages `cornerstone`'s existing plumbing to integrate with image loaders and metadata providers. The `demo` package in this repository contains a simple "metadata provider", named "WADORSHeaderProvider", that allows for querying metadata by instance and
 imageId.

-This repository's `@ohif/cornerstone-tools` is a "tools" library that, once initialized, will listen for custom events emitted by `@ohif/cornerstone-render`. Please note, the event naming and handling overlaps the events and event handling in the `cornerstone-tools` library. If you attempt to use `cornerstone-tools` in tandem, you will likely encounter issues. As this is a possible use case, please don't hesitate to report any issues and propose potential solutions.
+This repository's `@cornerstone/tools` is a "tools" library that, once initialized, will listen for custom events emitted by `@cornerstone/core`. Please note, the event naming and handling overlaps the events and event handling in the `cornerstone-tools` library. If you attempt to use `cornerstone-tools` in tandem, you will likely encounter issues. As this is a possible use case, please don't hesitate to report any issues and propose potential solutions.


Maybe specify in the "legacy" cornerstone-tools library

swederik · 2022-03-30T08:24:11Z

packages/docs/src/pages/index.module.css

@@ -1,4 +1,5 @@
 /* stylelint-disable docusaurus/copyright-header */
+@import url('https://fonts.googleapis.com/css2?family=Open+Sans&display=swap');


Where are we using Open Sans? I thought we used Inter?

swederik · 2022-03-30T08:25:07Z

packages/docs/webpackConfigurationPlugin.js

+const path = require('path')
+const CopyPlugin = require('copy-webpack-plugin')
+
+// If we want to embed examples in the docusaurus we need the following


Why did you comment this out? The examples will not work with this commented out.

You need to have:

devServer: {
// historyApiFallback: true,
// headers: {
// 'Cross-Origin-Embedder-Policy': 'require-corp',
// 'Cross-Origin-Opener-Policy': 'same-origin',
// },
// },

Otherwise we cannot use docusaurus dev server to look at examples.

The rest of it is only necessary for the in-docs example though, so you can comment that out.

swederik · 2022-03-30T08:28:10Z

yarn.lock

@@ -5707,15 +5707,15 @@ chardet@^0.7.0:
  integrity sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==

 cheerio-select@^1.5.0:
-  version "1.5.0"


Why are there yarn.lock changes on this PR? There doesn't seem to be any package.json changes.

swederik · 2022-03-30T08:29:03Z

packages/docs/package.json

@@ -37,7 +37,20 @@
    "prism-react-renderer": "^1.2.1",
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
-    "url-loader": "^4.1.1"
+    "url-loader": "^4.1.1",
+    "@cornerstonejs/core": "^0.2.1",


if you removed the example from the homepage you can remove this stuff too

swederik · 2022-03-30T08:29:29Z

packages/docs/docs/tutorials/tools-usage.md

@@ -34,8 +34,8 @@ viewportPane.appendChild(canvas)
 The following code-block explains how to add annotation tools to a canvas.

 ```js
-import { ToolGroupManager, ToolBindings } from '@ohif/cornerstone-tools'
-import * as csTools3D from '@ohif/cornerstone-tools'
+import { ToolGroupManager, ToolBindings } from '@cornerstone/tools'


@cornerstonejs

sedghi and others added 16 commits March 29, 2022 23:16

try to fix flaky test

deeab19

try to fix flaky tests

f039bc2

add docs

cedb272

add more docs to concepts

4e16055

wip for demo in the landing page

9c6a758

fix webpack config

fed3f44

docs: Update README and add CODE_OF_CONDUCT

da7f54f

remove the demo from landing page

48746ff

change csiv to streaming-wadors and add documentation

54e234e

add tools documentation

bd33fee

add migration guides

266bce5

add toolGroup documentation

fbe06ee

add synchronizer documentation

20e44dd

add initial stylings

9023c2c

add annotations concept docs

2f45771

add some documentation for segmentation concepts

5a6c929

sedghi force-pushed the docs-segmentation branch from ebbf7e6 to 5a6c929 Compare March 30, 2022 03:20

sedghi changed the title ~~Docs~~ docs: concept docs Mar 30, 2022

swederik reviewed Mar 30, 2022

View reviewed changes

re-add the dev server requirements

9fd971d

swederik merged commit 4beaef9 into main Mar 30, 2022

swederik deleted the docs-segmentation branch March 30, 2022 09:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: concept docs #25

docs: concept docs #25

sedghi commented Mar 28, 2022

swederik left a comment

swederik Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

sedghi Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

swederik Mar 30, 2022

		@@ -17,36 +17,32 @@ The cache has two main components: a volatile portion for images and a non-volat
		- When you allocate volumes, these are non-volatile and reserve a block of memory from the cache. Volumes must be released manually.


		## Decaching

		@@ -1,4 +1,5 @@
		/* stylelint-disable docusaurus/copyright-header */
		@import url('https://fonts.googleapis.com/css2?family=Open+Sans&display=swap');

docs: concept docs #25

docs: concept docs #25

Conversation

sedghi commented Mar 28, 2022

swederik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment