diff --git a/docs/latest/README.md b/docs/latest/README.md index 023f42014..4f9a8892b 100644 --- a/docs/latest/README.md +++ b/docs/latest/README.md @@ -38,7 +38,7 @@ our integration and extension points. Check out these helpful links: - Ready to dive into some code? Check out our - [Getting Started Guide](./essentials/getting-started.md). + [Getting Started Guide](./getting-started.md). - We're an active, vibrant community. [Learn how you can be more involved.](./contributing/index.md) - Feeling lost? Read our [help page](./help.md). diff --git a/docs/latest/SUMMARY.md b/docs/latest/SUMMARY.md index 9d7cbeec3..62c4a4c47 100644 --- a/docs/latest/SUMMARY.md +++ b/docs/latest/SUMMARY.md @@ -1,8 +1,8 @@ # OHIF Viewers - [Our Process](our-process.md) +- [Getting Started](getting-started.md) - Essentials - - [Getting Started](essentials/getting-started.md) - [Installation](essentials/installation.md) - [Data Source](essentials/data-source.md) - [Configuration](essentials/configuration.md) diff --git a/docs/latest/contributing/index.md b/docs/latest/contributing/index.md index b9f2f0f7e..dac5c0dae 100644 --- a/docs/latest/contributing/index.md +++ b/docs/latest/contributing/index.md @@ -7,7 +7,7 @@ like to discuss the changes you intend to make to clarify where or how they 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) +- [Getting Started](/getting-started.md) - [Architecture](/architecture/index.md) Pull requests that are: diff --git a/docs/latest/deployment/recipes/build-for-production.md b/docs/latest/deployment/recipes/build-for-production.md index 5c607d0c0..394e5a71e 100644 --- a/docs/latest/deployment/recipes/build-for-production.md +++ b/docs/latest/deployment/recipes/build-for-production.md @@ -1,8 +1,7 @@ # Build for Production -> If you've already followed the -> ["Getting Started" Guide](/essentials/getting-started.md), you can skip ahead -> to [Configuration](#configuration) +> If you've already followed the ["Getting Started" Guide](/getting-started.md), +> you can skip ahead to [Configuration](#configuration) ## Overview diff --git a/docs/latest/essentials/data-source.md b/docs/latest/essentials/data-source.md index 372a42525..46ee770bd 100644 --- a/docs/latest/essentials/data-source.md +++ b/docs/latest/essentials/data-source.md @@ -1,8 +1,9 @@ # Data Source -After following the steps outlined in [Getting Started](./getting-started.md), -you'll notice that the OHIF Viewer has data for several studies and their -images. You didn't add this data, so where is it coming from? +After following the steps outlined in +[Getting Started](./../getting-started.md), you'll notice that the OHIF Viewer +has data for several studies and their images. You didn't add this data, so +where is it coming from? By default, the viewer is configured to connect to a remote server hosted by the nice folks over at [dcmjs.org][dcmjs-org]. While convenient for getting started, diff --git a/docs/latest/essentials/getting-started.md b/docs/latest/getting-started.md similarity index 90% rename from docs/latest/essentials/getting-started.md rename to docs/latest/getting-started.md index 9c992d045..db0216371 100644 --- a/docs/latest/essentials/getting-started.md +++ b/docs/latest/getting-started.md @@ -75,7 +75,7 @@ You should see the following output: ### Building for Production > More comprehensive guides for building and publishing can be found in our -> [deployment docs](./../deployment/index.md) +> [deployment docs](./deployment/index.md) ```bash # Build static assets to host a PWA @@ -85,12 +85,6 @@ yarn run build yarn run build:package ``` -## Next Steps - -Take a look at the sidebar. Depending on how you intend to use The OHIF Viewer, -different topics may be more pertinent than others. At a minimum, reading "The -Essentials" and the deployment recipes should be a good starting point. - ## Troubleshooting - If you receive a _"No Studies Found"_ message and do not see your studies, try @@ -98,7 +92,8 @@ Essentials" and the deployment recipes should be a good starting point. - If you see a 'Loading' message which never resolves, check your browser JavaScript console inside the Developer Tools to identify any errors. - If you see any errors in your server console, check the - [Troubleshooting](./troubleshooting.md) page for more in depth advice. + [Troubleshooting](./essentials/troubleshooting.md) page for more in depth + advice.