chore(overlays): general documentation for application developers

packages/overlays/README.md

@@ -5,16 +5,17 @@
 Supports different types of overlays like dialogs, toasts, tooltips, dropdown, etc...
 Manages their position on the screen relative to other elements, including other overlays.
 
-## Overlays manager
+## Features
-
+- [**Overlays Manager**](./docs/OverlaysManager.md), a global repository keeping track of all different types of overlays.
-This is a global singleton needed to manage positions of multiple dialogs next to each other on the entire page.
+- [**Overlays Occurrences**](./docs/OverlayOccurrences.md), outline of all possible occurrences of overlays. Divided into two main types:
-It does the job automatically, but you need to add every newly created overlay to it using the code provided below:
+  - [**Global Overlay Controller**](./docs/GlobalOverlayController.md), controller for overlays relative to the viewport.
+  - [**Local Overlay Controller**](./docs/LocalOverlayController.md), controller for overlays positioned next to invokers they are related to.
 
 ## How to use
 
 ### Installation
 ```sh
-npm i --save @lion/ajax
+npm i --save @lion/overlays
 ```
 
 ### Example
@@ -29,28 +30,3 @@ const myCtrl = overlays.add(
 // name OverlayTypeController is for illustration purpose only
 // please read below about existing classes for different types of overlays
 ```
-
-## GlobalOverlayController
-
-This is a base class for different global overlays (e.g. a dialog) - the ones positioned relatively to the viewport.
-You should not use this controller directly unless you want to create a unique type of global overlays which is not supported out of the box.
-
-All supported types of global overlays are described below.
-
-### ModalDialogController
-
-```js
-import { ModalDialogController } from '@lion/overlays';
-```
-
-This is an extension of GlobalOverlayController configured to create accessible modal dialogs.
-
-## LocalOverlayController
-
-This is a base class for different local overlays (e.g. a tooltip) - the ones positioned next to invokers they are related to.
-You should not use this controller directly unless you want to create a unique type of local overlays which is not supported out of the box.
-
-All supported types of local overlays are described below.
-
-This is currently WIP.
-Stay tuned for updates on new types of overlays.

packages/overlays/docs/GlobalOverlayController.md

@@ -0,0 +1,31 @@
+# GlobalOverlayController
+
+This is a base class for different global overlays (e.g. a dialog, see [Overlay Occurrences](./OverlayOccurrences.md) - the ones positioned relatively to the viewport.
+You should not use this controller directly unless you want to create a unique type of global overlays which is not supported out of the box.
+
+All supported types of global overlays are described below.
+
+## How to use
+
+### Installation
+```sh
+npm i --save @lion/overlays
+```
+
+### Example
+```js
+import { overlays } from '@lion/overlays';
+
+const myCtrl = overlays.add(
+  new GlobalOverlayController({
+    /* options */
+  })
+);
+```
+
+### ModalDialogController
+A specific extension of GlobalOverlayController configured to create accessible modal dialogs.
+
+```js
+import { ModalDialogController } from '@lion/overlays';
+```

packages/overlays/docs/LocalOverlayController.md

@@ -0,0 +1,28 @@
+# LocalOverlayController
+
+This is a base class for different local overlays (e.g. a [tooltip](../../tooltip/), see [Overlay System Implementation](./OverlaySystemImplementation.md) - the ones positioned next to invokers they are related to.
+You should not use this controller directly unless you want to create a unique type of local overlays which is not supported out of the box.
+
+All supported types of local overlays are described below.
+
+## How to use
+
+### Installation
+```sh
+npm i --save @lion/overlays
+```
+
+### Example
+```js
+import { overlays } from '@lion/overlays';
+
+const myCtrl = overlays.add(
+  new LocalOverlayController({
+    /* options */
+  })
+);
+```
+
+
+This is currently WIP.
+Stay tuned for updates on new types of overlays.