Merge pull request #316 from manparvesh/v2

update docs
yoda-pa · Oct 13, 2024 · 2b755aa · 2b755aa
2 parents e76ded0 + b447b9b
commit 2b755aa
Show file tree

Hide file tree

Showing 13 changed files with 249 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -29,19 +29,62 @@ Yoda is designed to be extensible. You can write your own plugins or use the AI
 
 The help command will list all the available plugins.
 
-```bash
-$ yoda --help
 ```
-
-![img.png](docs/docs/img.png)
+❯ yoda --help
+                                                                            
+ Usage: yoda [OPTIONS] COMMAND [ARGS]...                                    
+                                                                            
+╭─ Options ────────────────────────────────────────────────────────────────╮
+│ --install-completion          Install completion for the current shell.  │
+│ --show-completion             Show completion for the current shell, to  │
+│                               copy it or customize the installation.     │
+│ --help                        Show this message and exit.                │
+╰──────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────╮
+│ ai       AI command. Allows you to communicate with your local LLMs      │
+│ config   Config management                                               │
+│ dev                                                                      │
+│ init     Init yoda configurations                                        │
+│ plugin   Commands to manage plugins                                      │
+│ url                                                                      │
+╰──────────────────────────────────────────────────────────────────────────╯
+```
 
 You can find the details for each plugin with the `--help` flag. Some examples:
 
-![img_1.png](docs/docs/img_1.png)
-
-![img_2.png](docs/docs/img_2.png)
+```
+❯ yoda ai --help
+                                                                            
+ Usage: yoda ai [OPTIONS] COMMAND [ARGS]...                                 
+                                                                            
+ AI command. Allows you to communicate with your local LLMs                 
+                                                                            
+╭─ Options ────────────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                              │
+╰──────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────╮
+│ chat               Chat with the AI model based on the provided prompt.  │
+│ generate-command   Generate code for a new plugin command based on the   │
+│                    provided prompt.                                      │
+╰──────────────────────────────────────────────────────────────────────────╯
+```
 
-![img_3.png](docs/docs/img_3.png)
+```
+❯ yoda dev --help
+                                                                            
+ Usage: yoda dev [OPTIONS] COMMAND [ARGS]...                                
+                                                                            
+╭─ Options ────────────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                              │
+╰──────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────╮
+│ checksite          Check if a site is up and running                     │
+│ coinflip           Flip a coin!                                          │
+│ generatepassword   Generates a secure password                           │
+│ speedtest          Test your internet connection                         │
+│ whois              Check whois info for a domain name                    │
+╰──────────────────────────────────────────────────────────────────────────╯
+```
 
 ### Write your own plugin for Yoda
 
@@ -121,7 +164,12 @@ def weather(location: str, units: Optional[str] = None):
 ```
 
 .. or chat with Yoda:
-![img_5.png](docs/docs/img_5.png)
+
+```bash
+❯ yoda ai chat "How are you?"
+🤖 AI response:
+I am well, young one. The Force is strong with me.
+```
 
 ## Development setup
 

diff --git a/docs/docs/config.md b/docs/docs/config.md
@@ -0,0 +1,21 @@
+# Config Management
+
+```
+❯ yoda config --help
+                                                                                                                                                       
+ Usage: yoda config [OPTIONS] COMMAND [ARGS]...                                                                                                        
+                                                                                                                                                       
+ Config management                                                                                                                                     
+                                                                                                                                                       
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                                                                                                         │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ get    Get value of a key set in yoda config                                                                                                        │
+│ init   Initializes a sqlite db that will store the config                                                                                           │
+│ list   List all key-value pairs in the config                                                                                                       │
+│ set    Set a value for a key in config                                                                                                              │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+::: yodapa.core.config
diff --git a/docs/docs/img.png b/docs/docs/img.png
diff --git a/docs/docs/img_1.png b/docs/docs/img_1.png
diff --git a/docs/docs/img_2.png b/docs/docs/img_2.png
diff --git a/docs/docs/img_3.png b/docs/docs/img_3.png
diff --git a/docs/docs/img_5.png b/docs/docs/img_5.png
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -29,19 +29,62 @@ Yoda is designed to be extensible. You can write your own plugins or use the AI
 
 The help command will list all the available plugins.
 
-```bash
-$ yoda --help
 ```
-
-![img.png](img.png)
+❯ yoda --help
+                                                                            
+ Usage: yoda [OPTIONS] COMMAND [ARGS]...                                    
+                                                                            
+╭─ Options ────────────────────────────────────────────────────────────────╮
+│ --install-completion          Install completion for the current shell.  │
+│ --show-completion             Show completion for the current shell, to  │
+│                               copy it or customize the installation.     │
+│ --help                        Show this message and exit.                │
+╰──────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────╮
+│ ai       AI command. Allows you to communicate with your local LLMs      │
+│ config   Config management                                               │
+│ dev                                                                      │
+│ init     Init yoda configurations                                        │
+│ plugin   Commands to manage plugins                                      │
+│ url                                                                      │
+╰──────────────────────────────────────────────────────────────────────────╯
+```
 
 You can find the details for each plugin with the `--help` flag. Some examples:
 
-![img_1.png](img_1.png)
-
-![img_2.png](img_2.png)
+```
+❯ yoda ai --help
+                                                                            
+ Usage: yoda ai [OPTIONS] COMMAND [ARGS]...                                 
+                                                                            
+ AI command. Allows you to communicate with your local LLMs                 
+                                                                            
+╭─ Options ────────────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                              │
+╰──────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────╮
+│ chat               Chat with the AI model based on the provided prompt.  │
+│ generate-command   Generate code for a new plugin command based on the   │
+│                    provided prompt.                                      │
+╰──────────────────────────────────────────────────────────────────────────╯
+```
 
-![img_3.png](img_3.png)
+```
+❯ yoda dev --help
+                                                                            
+ Usage: yoda dev [OPTIONS] COMMAND [ARGS]...                                
+                                                                            
+╭─ Options ────────────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                              │
+╰──────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────╮
+│ checksite          Check if a site is up and running                     │
+│ coinflip           Flip a coin!                                          │
+│ generatepassword   Generates a secure password                           │
+│ speedtest          Test your internet connection                         │
+│ whois              Check whois info for a domain name                    │
+╰──────────────────────────────────────────────────────────────────────────╯
+```
 
 ### Write your own plugin for Yoda
 
@@ -121,7 +164,12 @@ def weather(location: str, units: Optional[str] = None):
 ```
 
 .. or chat with Yoda:
-![img_5.png](img_5.png)
+
+```bash
+❯ yoda ai chat "How are you?"
+🤖 AI response:
+I am well, young one. The Force is strong with me.
+```
 
 ## Development setup
 

diff --git a/docs/docs/modules.md b/docs/docs/modules.md