Added intial customization

Added initial customization and main page

Signed-off-by: JJ Asghar <[email protected]>

Author: jjasghar

docs/index.md

@@ -1,17 +1,23 @@
-# Welcome to MkDocs
+## Welcome to InstructLab!
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+InstructLab 🐶 uses a novel synthetic data-based alignment tuning method for
+Large Language Models (LLMs.) The "**lab**" in Instruct**Lab** 🐶 stands for
+[**L**arge-Scale **A**lignment for Chat**B**ots](https://arxiv.org/abs/2403.01081) [1].
 
-## Commands
+[1] Shivchander Sudalairaj*, Abhishek Bhandwaldar*, Aldo Pareja*, Kai Xu, David D.
+Cox, Akash Srivastava*. "LAB: Large-Scale Alignment for ChatBots", arXiv preprint arXiv:
+2403.01081, 2024. (* denotes equal contributions)
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
+## 📋 Requirements
+
+- **🍎 Apple M1/M2/M3 Mac or 🐧 Linux system** (tested on Fedora).
+  We anticipate support for more operating systems in the future.
+- C++ compiler
+- Python 3.10 or Python 3.11
+- Approximately 60GB disk space (entire process)
+
+> **NOTE:** Python 3.12 is currently not supported, because some dependencies don't work on Python 3.12, yet.
+<!-- -->
+> **NOTE:** When installing the `ilab` CLI on macOS, you may have to run the `xcode-select --install` command, installing the required packages previously listed.
 
-## Project layout
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -1,4 +1,91 @@
 site_name: docs.instructlab.ai
 site_url: https://docs.instructlab.ai
+
+# Repository
+repo_name: docs.instructlab.ai
+repo_url: https://github.com/instructlab/docs.instructlab.ai
+edit_uri: edit/main/docs
+
+# Navigation
+nav:
+  - Welcome:
+    - About InstructLab: README.md
+  - Getting Started:
+    - Mac Metal: getting-started/mac_metal.md
+    - Linux NVidia: getting-started/linux_nvidia.md
+    - Linux AMD: getting-started/linux_amd.md
+  - References:
+    - Additional Resources: resources/RESOURCES.md
+    - Contributors: resources/CONTRIBUTORS.md
+    - MkDocs Cheatsheet: resources/MKDOCS.md
+    - Admin Guide: resources/ADMIN.md
+
+## YOU SHOULD NOT NOT CHANGE BELOW THIS LINE
+
+# Copyright
+copyright: Copyright © 2024- Red Hat Inc.
+
 theme:
     name: material
+	icon:
+	    logo: material/library
+	  logo: images/ilab_dog.png
+	  features:
+	    - navigation.tabs
+	    #- navigation.instant
+	  palette:
+	    scheme: default
+	    primary: purple
+	    accent: purple
+
+# Plugins
+plugins:
+  - search
+  - social
+
+# Customization
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/instructlab
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/instructlab
+    - icon: fontawesome/brands/youtube
+      link: https://www.youtube.com/user/instructlab
+
+# Extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde