Merge pull request #448 from HumanBrainProject/feat/userdoc

chore: fixing copy

docs/index.md

 # Interactive Atlas Viewer
 
-Interactive Atlas Viewer is a browser based viewer of brain atlases. Strong integration with the Human Brain Project Knowledge Graph project allow data/datasets that are semantically and spatially anchored to be easily accessible with minimal setup required.
+The interactive atlas viewer is a browser based viewer of brain atlases. Tight integration with the Human Brain Project Knowledge Graph allows seamless querying of semantically and spatially anchored datasets. 
 
 ![](images/desktop_bigbrain_cortical.png)
 
-## Important links
+## Links
 
 - production: <https://interactive-viewer.apps.hbp.eu>
 - production: <https://atlases.ebrains.eu/viewer>

docs/usage/gettingStarted.md

@@ -2,10 +2,10 @@
 
 ## Requirements
 
-Interactive Atlas Viewer uses webgl 2.0 under the hood. While modern operating system and browser supports webgl 2.0, specific hardware combinations may yield limited support for webgl 2.0. 
+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 support webgl 2.0, you can visit <https://get.webgl.org/webgl2/>.
+    To check if your device and browser combination support webgl 2.0, visit <https://get.webgl.org/webgl2/>.
 
 ### Desktop
 

docs/usage/navigating.md

-# Navigation
+# Navigating
 
 ## Navigating the viewer
 
-The interactive atlas viewer can be accessed via either a desktop with a Chrome or Firefox browser or an Android phone or tablet. The navigation gestures vary slightly between the two platforms.
+The interactive atlas viewer can be accessed from either a desktop or an Android mobile device. The navigation scheme vary slightly between the two platforms.
 
 | | Desktop | Mobile |
 | --- | --- | --- |
@@ -12,16 +12,16 @@ The interactive atlas viewer can be accessed via either a desktop with a Chrome
 | Next slice (_slice view_) | `ctrl` + `mouse wheel` | |
 | Next 10 slice (_slice view_) | `ctrl` + `shift` + `mouse wheel` | |
 
-## Navigate to region of interest
+## Navigating to a region of interest
 
 !!! warning
-    Not all regions have a position of interest defined. If absent, the UI would simply be missing.
+    Not all regions have a position of interest curated. If absent, the UI elements described below would be missing.
     
-    If you believe some regions should have a position of interest defined, or the position of interest was incorrectly defined, please let us know. 
+    If you believe some regions should have a position of interest curated, or the position of interest was incorrectly curated, please contact us. 
 
-### From viewer
+### From the viewer
 
-`click` on a segmented region will bring up a region specific dialog
+`click` on a segmented region to bring up a region specific dialog
 
 [![](images/bigbrain_region_specific_dialog.png)](images/bigbrain_region_specific_dialog.png)
 
@@ -41,8 +41,6 @@ From here, `click` on `Navigate`.
 
 ## Navigation status panel
 
-You can find navigation status of the viewer at the lower left corner. You can reset the `position`, `rotation` and/or `zoom`. 
-
-You can also change the units between `physical` (mm) and `voxel` from the image space.
+You can find the navigation status in the lower left corner of the interactive atlas viewer. You can reset the `position`, `rotation` and/or `zoom`, as well as toggling the units between `physical` (mm) and `voxel`.
 
 [![](images/navigation_status.png)](images/navigation_status.png)

docs/usage/search.md

-# Search Knowldge Graph
+# Searching
 
 The interactive viewer fetches datasets semantically linked to [selected regions](selecting.md#selecting-deselecting-regions). If no regions are selected, all datasets associated with a parcellation will be returned.
 
 [![](images/bigbrain_search_interface.png)](images/bigbrain_search_interface.png)
 
-## Open / Close the search interface
+## Opening / Closing the search interface
 
-The search interface will opened by either:
+The search interface can be opened by either:
 
 - [selecting any region](selecting.md#selecting-deselecting-regions)
 - manually, `click` on `Explore`
@@ -16,28 +16,26 @@ The search interface will opened by either:
 The search interface can be closed by clicking the `Collapse` button
 [![](images/bigbrain_collapse_search.png)](images/bigbrain_collapse_search.png)
 
-## Browser dataset
+## Browsing dataset
 
-`click` on any dataset entry to get a detail view of the said dataset
+`click` on any dataset entry to display a detailed view.
 
 [![](images/bigbrain_click_dataset.png)](images/bigbrain_click_dataset.png)
 
 [![](images/area_te10_detail.png)](images/area_te10_detail.png)
 
-## Filter / Unfilter results
+## Filtering search results
 
-You can narrow down the search result by filtering. Currently, the only filter available is by methods.
-
-`click` the banner `Related Datasets` to reveal the filter options. select all methods of interest (selecting none will apply no filter). 
+You can filter the search result by `click`ing the banner `Related Datasets`. This reveals the filter options. Select/Deselect options to apply the filter.
 
 [![](images/bigbrain_search_filter.png)](images/bigbrain_search_filter.png)
 
 [![](images/bigbrain_search_filter_expanded.png)](images/bigbrain_search_filter_expanded.png)
 
 !!! warning
-    Selecting no filter option is not the same as selecting all options. 
+    Selecting no filter option is not the same as selecting all filter options. 
     
-    There may be datasets without any _methods_ defined. These datasets will be shown if no filter is applied (deselecting all options), but will not show up if all options are selected
+    There may be datasets without any _methods_ curated. These datasets will be shown if no filter is applied (i.e. deselecting all options), but will not show up if all options are selected.
 
 To reset all filters, `click` the `filter icon`
 

docs/usage/selecting.md

-# Selection
+# Selecting
 
-## Selecting a template / an atlas
+## Selecting a template / atlas
 
-Interactive Atlas Viewer supports a number of atlases.
+The interactive atlas viewer supports a number of atlases.
 
 ### From homepage
 
-At the home page, the atlases are categorised under the template space.
+On the home page, the atlases are categorised under their respective template spaces.
 
 [![](images/home.png)](images/home.png)
 
-Click on any of the parcellation listed, the interactive atlas viewer will load the parcellation in the corresponding template space
+Select any of the parcellations listed, the interactive atlas viewer will load the parcellation in the corresponding template space.
 
-Clicking on the template card will load the template and the first parcellation in the corresponding template space.
+Clicking on the template card will load the template and the first of the listed parcellation under the template space.
 
 ### From viewer
 
-If an atlas is already loaded, the list of available templates and parcellation can be accessed from the side bar.
+If an atlas is already loaded, the list of available templates and parcellations can be accessed from the side bar.
 
 [![](images/bigbrain_parcellation_selector_open.png)](images/bigbrain_parcellation_selector_open.png)
 
@@ -31,23 +31,23 @@ Information on the selected template or parcellation can be revealed by `hoverin
 
 ## Browsing regions
 
-An atlas will likely contain parcellated regions of interest. The interactive atlas viewer presents several ways of browsing the regions of interest.
+There exist several ways of browsing the parcellated regions in a selected parcellation in the interactive atlas viewer.
 
-### From viewer
+### From the viewer
 
-Each of the region is represented as a coloured segmentation in _slice views_ (and in most circumstances in _3d view_ as well). `mouse hover` on the segment will bring up a contextual menu, showing the name of the region.
+Each of the region is represented as a coloured segment in _slice views_ (and in most circumstances, in _3d view_ as well). `mouse hover` on the segment will bring up a contextual tooltip, showing the name of the region.
 
 [![](images/bigbrain_region_onhover.png)](images/bigbrain_region_onhover.png)
 
-### From quick search
+### Using the quick search box
 
-The interactive atlas viewer provides a quick search tool, which allow user to quickly find a region of interest by keyword
+Using the quick search box, regions of interest may be searched using keywords.
 
 [![](images/bigbrain_quicksearch.png)](images/bigbrain_quicksearch.png)
 
 [![](images/bigbrain_quicksearch_hoc.png)](images/bigbrain_quicksearch_hoc.png)
 
-### From hierarchy tree
+### Using the hierarchical tree
 
 To view the full hierarchy, `click` the _hierarchy tree_ button. 
 
@@ -57,23 +57,23 @@ To view the full hierarchy, `click` the _hierarchy tree_ button.
 
 ## Selecting / Deselecting region(s)
 
-Selecting region(s) indicate a certain level of interest of these regions. Additional information on the selected regions, such as region descriptions, semantically linked datasets and so on, will be [fetched and displayed](search.md).
+Region(s) of interest may also be selected, which will [fetch and display](search.md) additional information, such as descriptions and semantically linked datasets, about the region(s).
 
-### From viewer
+### From the viewer
 
-`click` on a segmented region will bring up a region specific dialog
+`click` on a region (coloured segment) to bring up a context specific menu.
 
 [![](images/bigbrain_region_specific_dialog.png)](images/bigbrain_region_specific_dialog.png)
 
 From here, `click` on `[] Selected` checkbox will select or deselect the region.
 
-### From quick search
+### From the quick search box
 
 `click` on the name or the checkbox will select or deselect the region.
 
 [![](images/bigbrain_quicksearch_hoc.png)](images/bigbrain_quicksearch_hoc.png)
 
-### From hierarchy tree
+### From the hierarchical tree
 
 `click` on any _region_ or _parent region_ will (mass) select / deselect the region(s). 
 

mkdocs.yml

@@ -17,9 +17,9 @@ pages:
   - Home: 'index.md'
   - User documentation:
     - Getting started: 'usage/gettingStarted.md'
-    - Selection: 'usage/selecting.md'
-    - Navigation: 'usage/navigating.md'
-    - Search KG: 'usage/search.md'
+    - Selecting: 'usage/selecting.md'
+    - Navigating: 'usage/navigating.md'
+    - Searching: 'usage/search.md'
   - Advanced usage:
     - Keyboard shortcuts: 'advanced/keyboard.md'
     - URL parsing: 'advanced/url.md'