Added some emojis and fixed locations of files.

Started to fill in the gaps of some of the documentation. Signed-off-by: JJ Asghar <[email protected]>
instructlab · Aug 29, 2024 · 2a8972e · 2a8972e
1 parent cf3a1be
commit 2a8972e
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 12 deletions.
diff --git a/docs/.index.md.swp b/docs/.index.md.swp
diff --git a/docs/getting-started/linux_amd.md b/docs/getting-started/linux_amd.md
@@ -0,0 +1,4 @@
+# Getting Started Linux AMD
+
+
+TODO
diff --git a/docs/getting-started/linux_nvidia.md b/docs/getting-started/linux_nvidia.md
@@ -1,4 +1,4 @@
-# Getting Started Mac Metal
+# Getting Started Linux NVidia
 
 
 TODO
diff --git a/docs/getting-started/llinux_amd.md b/docs/getting-started/llinux_amd.md
diff --git a/docs/images/ilab_dog.png b/docs/images/ilab_dog.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,13 @@
-## Welcome to InstructLab!
+---
+title: Introduction
+description: Introduction docs.instructlab.ai
+logo: images/ilab_dog.png
+---
+# Welcome to InstructLab!
 
+## Introduction
+
+### ? What is InstructLab?
 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].
@@ -8,6 +16,10 @@ Large Language Models (LLMs.) The "**lab**" in Instruct**Lab** 🐶 stands for
 Cox, Akash Srivastava*. "LAB: Large-Scale Alignment for ChatBots", arXiv preprint arXiv:
 2403.01081, 2024. (* denotes equal contributions)
 
+### 🔭 Use Cases
+
+TODO
+
 ## 📋 Requirements
 
 - **🍎 Apple M1/M2/M3 Mac or 🐧 Linux system** (tested on Fedora).
@@ -16,8 +28,9 @@ Cox, Akash Srivastava*. "LAB: Large-Scale Alignment for ChatBots", arXiv preprin
 - 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.
+!!! note
+    Python 3.12 is currently not supported, because some dependencies don't work on Python 3.12, yet.
 
+!!! tip
+    When installing the `ilab` CLI on macOS, you may have to run the `xcode-select --install` command, installing the required packages previously listed.
 
diff --git a/resources/CONTRIBUTORS.md → docs/resources/CONTRIBUTORS.md b/resources/CONTRIBUTORS.md → docs/resources/CONTRIBUTORS.md
diff --git a/resources/MKDOCS.md → docs/resources/MKDOCS.md b/resources/MKDOCS.md → docs/resources/MKDOCS.md
@@ -153,12 +153,12 @@ Yes, these work. :smiley: :+1:
 
 ## Images
 
-![image](../images/ibm-cloud-sign-up.png)
+![image](../images/ilab_dog.png)
 
 Nunc eu odio eleifend, blandit leo a, volutpat sapien
 
 ## right align image
 
-![Placeholder](../images/ibm-cloud-sign-up.png){: align=right }
+![Placeholder](../images/ilab_dog.png){: align=right }
 
 Nunc eu odio eleifend, blandit leo a, volutpat sapien
diff --git a/resources/RESOURCES.md → docs/resources/RESOURCES.md b/resources/RESOURCES.md → docs/resources/RESOURCES.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,7 +9,7 @@ edit_uri: edit/main/docs
 # Navigation
 nav:
   - Welcome:
-    - About InstructLab: README.md
+    - About InstructLab: index.md
   - Getting Started:
     - Mac Metal: getting-started/mac_metal.md
     - Linux NVidia: getting-started/linux_nvidia.md