Merge pull request #79 from FZJ-INM1-BDA/chore/misc

[skip ci] update to doc

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)

docs/requirements.md

+# 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
+

docs/usage/gettingStarted.md

-# 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

docs/usage/misc.md

+# 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

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'