From 8ac62c34d504678bd957c7cd4402ef965d38af70 Mon Sep 17 00:00:00 2001
From: Xiao Gui <xgui3783@gmail.com>
Date: Fri, 27 Mar 2020 09:56:45 +0100
Subject: [PATCH] [skip ci] update to doc
---
docs/releases/v2.1.0.md | 3 +++
docs/requirements.md | 18 ++++++++++++++++++
docs/usage/gettingStarted.md | 29 -----------------------------
docs/usage/misc.md | 7 +++++++
mkdocs.yml | 3 ++-
5 files changed, 30 insertions(+), 30 deletions(-)
create mode 100644 docs/requirements.md
delete mode 100644 docs/usage/gettingStarted.md
create mode 100644 docs/usage/misc.md
diff --git a/docs/releases/v2.1.0.md b/docs/releases/v2.1.0.md
index c591727fa..6d0ee29bc 100644
--- a/docs/releases/v2.1.0.md
+++ b/docs/releases/v2.1.0.md
@@ -10,9 +10,12 @@
- (Re)allow the preview pane to be dragged around
- Slight tweak to UI, allow for better side navigation bar rendering
- Allow registered volume to be displayed on top of reference templates
+- Added DiFuMo atlases
+- Allow for bulk download of favourited datasets
## Bugfixes
+- Fixed a bug where plugin lifecycles were not implemented properly (#489)
- Fixed a bug where on parcellation load, the colour of the parcellation fails to load (#454, #462)
- Fixed a bug where, URL state is no longer parsed as state properly (#461)
- Fixed a bug where, switching template does not result in the new template to be loaded (#475)
diff --git a/docs/requirements.md b/docs/requirements.md
new file mode 100644
index 000000000..998dc6f77
--- /dev/null
+++ b/docs/requirements.md
@@ -0,0 +1,18 @@
+# System requirements
+
+Interactive atlas viewer relies on [WebGL2.0](https://en.wikipedia.org/wiki/WebGL). Whilst a large proportion of modern browsers support this technology, some browser vendors do not. Most notably, none of the Apple browsers (Safari on MacOS, [**any** browser on iOS](https://developer.apple.com/app-store/review/guidelines/#software-requirements)) support WebGL2.0.
+
+!!! info
+ To check if your device and browser combination support webgl 2.0, visit <https://get.webgl.org/webgl2/>.
+
+## Desktop
+
+- PC (Windows/Linux/MacOS)
+- Latest Chrome/Firefox
+- Dedicated graphics card (optional, but will drastically improve the performance)
+
+## Mobile
+
+- Android Smartphone
+- Latest Chrome/Firefox
+
diff --git a/docs/usage/gettingStarted.md b/docs/usage/gettingStarted.md
deleted file mode 100644
index 540b39bce..000000000
--- a/docs/usage/gettingStarted.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# Getting started
-
-## Requirements
-
-At its core, the interactive atlas viewer uses webgl 2.0. Whilst modern operating systems and browsers support webgl 2.0, please note that specific software and hardware combinations may have limited support.
-
-!!! info
- To check if your device and browser combination support webgl 2.0, visit <https://get.webgl.org/webgl2/>.
-
-### Desktop
-
-!!! tip
- If you have a touch enabled device, you can enable mobile UI via:
-
- `Click on Portrait` > `Settings` > `Enable Mobile UI`
-
-- PC (Windows/Linux/MacOS)
-- Chrome/Firefox
-- Dedicated GPU (not required, but will greatly enhance the experience)
-
-### Mobile
-
-- Android Smartphone
-- Chrome/Firefox
-
-## URL
-
-- <https://interactive-viewer.apps.hbp.eu>
-- <https://atlases.ebrains.eu/viewer>
\ No newline at end of file
diff --git a/docs/usage/misc.md b/docs/usage/misc.md
new file mode 100644
index 000000000..6d6b3f43b
--- /dev/null
+++ b/docs/usage/misc.md
@@ -0,0 +1,7 @@
+# Miscellaneous
+
+## Touch interface on desktop
+
+If you have a touch enabled device, and would like to use the touch interface, you can enable these UI via:
+
+`Click on Portrait` > `Settings` > `Enable Mobile UI`
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index ccd849296..0a43acdc0 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -16,12 +16,13 @@ markdown_extensions:
pages:
- Home: 'index.md'
+ - System requirements: 'requirements.md'
- User documentation:
- - Getting started: 'usage/gettingStarted.md'
- Selecting: 'usage/selecting.md'
- Navigating: 'usage/navigating.md'
- Searching: 'usage/search.md'
- Exploring connectivity: 'usage/connectivity.md'
+ - Miscellaneous: 'usage/misc.md'
- Advanced usage:
- Keyboard shortcuts: 'advanced/keyboard.md'
- URL parsing: 'advanced/url.md'
--
GitLab