feat: docs

ekkinox · Apr 17, 2023 · bfa7aaa · bfa7aaa
1 parent 326cd27
commit bfa7aaa
Show file tree

Hide file tree

Showing 12 changed files with 19 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 > AI powered terminal assistant.
 
-![Intro](docs/examples/intro.gif)
+![Intro](docs/_assets/intro.gif)
 
 ## Table of contents
 

diff --git a/docs/examples/chat.gif → docs/_assets/chat.gif b/docs/examples/chat.gif → docs/_assets/chat.gif
diff --git a/docs/examples/dev.gif → docs/_assets/dev.gif b/docs/examples/dev.gif → docs/_assets/dev.gif
diff --git a/docs/examples/docker.gif → docs/_assets/docker.gif b/docs/examples/docker.gif → docs/_assets/docker.gif
diff --git a/docs/examples/intro.gif → docs/_assets/intro.gif b/docs/examples/intro.gif → docs/_assets/intro.gif
diff --git a/docs/examples/k8s.gif → docs/_assets/k8s.gif b/docs/examples/k8s.gif → docs/_assets/k8s.gif
diff --git a/docs/examples/pipe.gif → docs/_assets/pipe.gif b/docs/examples/pipe.gif → docs/_assets/pipe.gif
diff --git a/docs/examples/pkg.gif → docs/_assets/pkg.gif b/docs/examples/pkg.gif → docs/_assets/pkg.gif
diff --git a/docs/examples/system.gif → docs/_assets/system.gif b/docs/examples/system.gif → docs/_assets/system.gif
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml
@@ -1,9 +1,11 @@
 main:
-  - title: "Posts"
-    url: /posts/
-  - title: "Categories"
-    url: /categories/
-  - title: "Tags"
-    url: /tags/
-  - title: "About"
-    url: /about/
+  - title: "Installation"
+    url: /installation/
+  - title: "Configuration"
+    url: /configuration/
+  - title: "CLI mode"
+    url: /cli/
+  - title: "REPL mode"
+    url: /repl/
+  - title: "Examples"
+    url: /examples/
diff --git a/docs/examples/README.md → docs/examples.md b/docs/examples/README.md → docs/examples.md
@@ -1,18 +1,14 @@
-# Yo - Usage examples
-
-> `Yo` can help you in many ways. Check some examples of what it can do for you.
-
 ## CLI mode
 
 `Yo` can be used in `CLI` mode to streamline your terminal workflow.
 
 For example, this is how it can assist you while developing an application:
 
-![](dev.gif)
+![](_assets/dev.gif)
 
 You can also pipe any input and make it work with it:
 
-![](pipe.gif)
+![](_assets/pipe.gif)
 
 ## REPL mode
 
@@ -22,22 +18,22 @@ You can also pipe any input and make it work with it:
 
 An example on how it can help you to manage your system:
 
-![](system.gif)
+![](_assets/system.gif)
 
 Or help you to manage your packages:
 
-![](pkg.gif)
+![](_assets/pkg.gif)
 
 It can also go way further, for example help you to manage docker resources:
 
-![](docker.gif)
+![](_assets/docker.gif)
 
 Or even help you while using a k8s cluster:
 
-![](k8s.gif)
+![](_assets/k8s.gif)
 
 ### Chat
 
 `Yo` is not made to just generate command lines. You can also engage in a discussion with it about any topics.
 
-![](chat.gif)
+![](_assets/chat.gif)
diff --git a/docs/index.md b/docs/index.md
@@ -3,4 +3,4 @@
 ```shell
 curl -sS https://raw.githubusercontent.com/ekkinox/yo/main/install.sh | bash
 ```
-[:fontawesome-brands-github: GitHub repository](https://github.com/ekkinox/yo)
+