From ff381c6521f9af59d08dde06517a7bff3fa3b956 Mon Sep 17 00:00:00 2001 From: dannyrb Date: Fri, 6 Dec 2019 22:21:52 -0500 Subject: [PATCH] docs: shift viewer specific docs to own section --- docs/latest/SUMMARY.md | 10 ++++++---- docs/latest/essentials/configuration.md | 2 ++ docs/latest/{essentials => }/scope-of-project.md | 4 ++-- docs/latest/viewer/configuration.md | 1 + docs/latest/viewer/index.md | 1 + docs/latest/{essentials => viewer}/themeing.md | 0 6 files changed, 12 insertions(+), 6 deletions(-) rename docs/latest/{essentials => }/scope-of-project.md (94%) create mode 100644 docs/latest/viewer/configuration.md create mode 100644 docs/latest/viewer/index.md rename docs/latest/{essentials => viewer}/themeing.md (100%) diff --git a/docs/latest/SUMMARY.md b/docs/latest/SUMMARY.md index 09536c90e..9d7cbeec3 100644 --- a/docs/latest/SUMMARY.md +++ b/docs/latest/SUMMARY.md @@ -6,14 +6,17 @@ - [Installation](essentials/installation.md) - [Data Source](essentials/data-source.md) - [Configuration](essentials/configuration.md) - - [Themeing](essentials/themeing.md) - [Translating](essentials/translating.md) - [Troubleshooting](essentials/troubleshooting.md) -- [Scope of Project](essentials/scope-of-project.md) +- [Contributing](contributing/index.md) + - [Continuous Integration](continous-integration.md) --- - [Architecture](architecture/index.md) +- [Viewer](viewer/index.md) + - [Configuration](viewer/configuration.md) + - [Themeing](viewer/themeing.md) - [Extensions](extensions/index.md) - [Registering](extensions/index.md#registering-an-extension) - [Lifecycle Hooks](extensions/index.md#lifecycle-hooks) @@ -53,7 +56,6 @@ --- - [FAQ](frequently-asked-questions.md) -- [Contributing](contributing/index.md) - - [Continuous Integration](continous-integration.md) +- [Scope of Project](scope-of-project.md) - [Browser Support](browser-support.md) - [Help](help.md) diff --git a/docs/latest/essentials/configuration.md b/docs/latest/essentials/configuration.md index 182eaa0ca..8a7624f86 100644 --- a/docs/latest/essentials/configuration.md +++ b/docs/latest/essentials/configuration.md @@ -4,6 +4,8 @@ > one up, check out the [`Data Source` Guide](./data-source.md) or a deployment > recipe that contains an open source Image Archive +- [Configuration Files](#configuration-files) + ## Overview ### Configuration Files diff --git a/docs/latest/essentials/scope-of-project.md b/docs/latest/scope-of-project.md similarity index 94% rename from docs/latest/essentials/scope-of-project.md rename to docs/latest/scope-of-project.md index ebd584c67..c0be0850c 100644 --- a/docs/latest/essentials/scope-of-project.md +++ b/docs/latest/scope-of-project.md @@ -13,7 +13,7 @@ like user preferences and previous query paramaters. Because of this, the Viewer has been built to be highly configurable to work with almost any web accessible data source. -![scope-of-project diagram](./../assets/img/scope-of-project.png) +![scope-of-project diagram](./assets/img/scope-of-project.png) To be more specific, the OHIF Viewer is a collection of HTML, JS, and CSS files. These can be delivered to your end users however you would like: @@ -36,7 +36,7 @@ many data sources. The OHIF Viewer's scope **DOES** include configuration and support for services that are protected with OpenID-Connect. In an effort to aide our users and contributors, we attempt to provide several -[deployment and hosting recipes](./../deployment/index.md) as potential starting +[deployment and hosting recipes](./deployment/index.md) as potential starting points. These are not meant to be rock solid, production ready, solutions; like most recipes, they should be augmented to best fit you and your organization's taste, preferences, etc. diff --git a/docs/latest/viewer/configuration.md b/docs/latest/viewer/configuration.md new file mode 100644 index 000000000..a025a48b1 --- /dev/null +++ b/docs/latest/viewer/configuration.md @@ -0,0 +1 @@ +# Configuration diff --git a/docs/latest/viewer/index.md b/docs/latest/viewer/index.md new file mode 100644 index 000000000..22d366efe --- /dev/null +++ b/docs/latest/viewer/index.md @@ -0,0 +1 @@ +# Viewer diff --git a/docs/latest/essentials/themeing.md b/docs/latest/viewer/themeing.md similarity index 100% rename from docs/latest/essentials/themeing.md rename to docs/latest/viewer/themeing.md