From a4f1b2195c85c1450ca4197f93fcc757e2d60d48 Mon Sep 17 00:00:00 2001 From: dannyrb Date: Fri, 6 Dec 2019 21:57:35 -0500 Subject: [PATCH] docs: clean up links --- README.md | 9 ++- .../advanced/_maintained-extensions-table.md | 62 ------------------- docs/latest/advanced/custom-tools.md | 9 --- .../advanced/monorepos-a-crash-courese.md | 23 ------- docs/latest/contributing/index.md | 2 +- platform/viewer/README.md | 4 +- 6 files changed, 7 insertions(+), 102 deletions(-) delete mode 100644 docs/latest/advanced/_maintained-extensions-table.md delete mode 100644 docs/latest/advanced/custom-tools.md delete mode 100644 docs/latest/advanced/monorepos-a-crash-courese.md diff --git a/README.md b/README.md index 8db5bc4e6..de91e462b 100644 --- a/README.md +++ b/README.md @@ -296,14 +296,14 @@ MIT © [OHIF](https://github.com/OHIF) [monorepo]: https://en.wikipedia.org/wiki/Monorepo [how-to-fork]: https://help.github.com/en/articles/fork-a-repo [how-to-clone]: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork -[ohif-architecture]: https://docs.ohif.org/advanced/architecture.html -[ohif-extensions]: https://docs.ohif.org/advanced/architecture.html +[ohif-architecture]: https://docs.ohif.org/architecture/index.html +[ohif-extensions]: https://docs.ohif.org/architecture/index.html [deployment-docs]: https://docs.ohif.org/deployment/ [react-url]: https://reactjs.org/ [pwa-url]: https://developers.google.com/web/progressive-web-apps/ [ohif-viewer-url]: https://www.npmjs.com/package/@ohif/viewer [configuration-url]: https://docs.ohif.org/essentials/configuration.html -[extensions-url]: https://docs.ohif.org/advanced/extensions.html +[extensions-url]: https://docs.ohif.org/extensions/ [platform-core]: platform/core/README.md [core-npm]: https://www.npmjs.com/package/@ohif/core @@ -326,5 +326,4 @@ MIT © [OHIF](https://github.com/OHIF) [vtk-npm]: https://www.npmjs.com/package/@ohif/extension-vtk - -[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FOHIF%2FViewers.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FOHIF%2FViewers?ref=badge_large) \ No newline at end of file +[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FOHIF%2FViewers.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FOHIF%2FViewers?ref=badge_large) diff --git a/docs/latest/advanced/_maintained-extensions-table.md b/docs/latest/advanced/_maintained-extensions-table.md deleted file mode 100644 index 43a558e46..000000000 --- a/docs/latest/advanced/_maintained-extensions-table.md +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ExtensionDescriptionModules
- - Cornerstone - - - A viewport powered by cornerstone.js. Adds support for 2D DICOM rendering and manipulation, as well as support for the tools features in cornerstone-tools. Also adds "CINE Dialog" to the Toolbar. - Viewport, Toolbar
- - VTK.js - - - A viewport powered by vtk.js. Adds support for volume renderings and advanced features like MPR. Also adds "3D Rotate" to the Toolbar. - Viewport, Toolbar
- DICOM HTML - - Renders text and HTML content for specific SopClassUIDs. - Viewport, SopClassHandler
- DICOM PDF - - Renders PDFs for a specific SopClassUID. - Viewport, SopClassHandler
- DICOM Microscopy - - Renders Microscopy images for a specific SopClassUID. - Viewport, SopClassHandler
diff --git a/docs/latest/advanced/custom-tools.md b/docs/latest/advanced/custom-tools.md deleted file mode 100644 index 5afbfb2d5..000000000 --- a/docs/latest/advanced/custom-tools.md +++ /dev/null @@ -1,9 +0,0 @@ -# Tool Management - -This is not yet exposed in an easy/convenient way. Most tools are currently -added by creating new Viewport, Toolbar, and SOPInstanceHandler extension -modules. You can read more about that approach in -[extensions](../extensions/index.md). - -In the near future, we intend to improve the extensibility of tools for existing -Viewports (like our Cornerstone.js and VTK.js viewports). diff --git a/docs/latest/advanced/monorepos-a-crash-courese.md b/docs/latest/advanced/monorepos-a-crash-courese.md deleted file mode 100644 index 1ddb598b2..000000000 --- a/docs/latest/advanced/monorepos-a-crash-courese.md +++ /dev/null @@ -1,23 +0,0 @@ -# MonoRepos: A Crash Course - -- [Lerna][lerna] - -Solutions: - -## Semantic-Release - -- [Semantic-Release](https://github.com/semantic-release/semantic-release/issues/193#issuecomment-462063871) -- [Multi-semantic-release](https://github.com/dhoulb/multi-semantic-release) -- [semantic-release-monorepo](https://github.com/Updater/semantic-release-monorepo) - -# Netlify - -- https://community.netlify.com/t/best-practices-for-deploying-sites-from-monorepos/818 - - - - -[lerna]: https://github.com/lerna/lerna - diff --git a/docs/latest/contributing/index.md b/docs/latest/contributing/index.md index bd3509a2e..b9f2f0f7e 100644 --- a/docs/latest/contributing/index.md +++ b/docs/latest/contributing/index.md @@ -8,7 +8,7 @@ should be implemented, please don't hesitate to create a new issue. At a minimum, you may want to read the following documentation: - [Essentials: Getting Started](/essentials/getting-started.md) -- [Advanced: Architecture](/advanced/architecture.md) +- [Architecture](/architecture/index.md) Pull requests that are: diff --git a/platform/viewer/README.md b/platform/viewer/README.md index ae3d20ee2..174d144d2 100644 --- a/platform/viewer/README.md +++ b/platform/viewer/README.md @@ -129,7 +129,7 @@ yarn run cy:run:ci > Large portions of the Viewer's functionality are maintained in other > repositories. To get a better understanding of the Viewer's architecture and > "where things live", read -> [our docs on the Viewer's architecture](https://docs.ohif.org/advanced/architecture.html#diagram) +> [our docs on the Viewer's architecture](https://docs.ohif.org/architecture/index.html#overview) It is notoriously difficult to setup multiple dependent repositories for end-to-end testing and development. That's why we recommend writing and running @@ -195,7 +195,7 @@ Links: [pwa-url]: https://developers.google.com/web/progressive-web-apps/ [ohif-viewer-url]: https://www.npmjs.com/package/ohif-viewer [configuration-url]: https://docs.ohif.org/essentials/configuration.html -[extensions-url]: https://docs.ohif.org/advanced/extensions.html +[extensions-url]: https://docs.ohif.org/extensions [react-viewer]: https://github.com/OHIF/Viewers/tree/react