docs(API docs): Gitlab pages

- Move docs folder within public folder for use with Gitlab Pages
- Specify branch name fot TypeDocs code links

Author: booleanhunter

.gitlab-ci.yml

@@ -0,0 +1,18 @@
+# Official framework image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/node/tags/
+image: node:latest
+
+# This folder is cached between builds
+# http://docs.gitlab.com/ee/ci/yaml/README.html#cache
+cache:
+  paths:
+    - node_modules/
+
+# Instructions to GitLab Runner for generating API documentation on Gitlab Pages
+pages:
+  script:
+    - npm install @microsoft/tsdoc typedoc
+    - npm run docs
+  artifacts:
+    paths:
+      - public/docs

README.md

@@ -2,6 +2,11 @@
 
 This library enables tracking of UI events when a user interacts with a React or React Native application.
 
+## Features
+- **Progressive** - Uses latest JavaScript features and design patterns for a React codebase.
+- **Extensible** - A modular architecture and usage of Dependency.Inversion patterns gives you flexibility and allows you to easily extend features.
+- **TypeScript support**.
+
 ## Supported events
 - Form Events
   - `onChange`

package.json

@@ -29,7 +29,7 @@
     "eject": "react-scripts eject",
     "storybook": "start-storybook -p 6006 -s public",
     "build-storybook": "build-storybook -s public",
-    "docs": "typedoc src/library/user-analytics"
+    "docs": "typedoc src/library/user-analytics --gitRevision develop --out ./public/docs"
   },
   "eslintConfig": {
     "extends": [