Merge pull request #227 from SmythOS/Documentation-updates

doc update

Author: alaa-eddine-k

docs/cli/assets/highlight.css

@@ -7,10 +7,10 @@
     --dark-hl-2: #CE9178;
     --light-hl-3: #0000FF;
     --dark-hl-3: #569CD6;
-    --light-hl-4: #098658;
-    --dark-hl-4: #B5CEA8;
-    --light-hl-5: #008000;
-    --dark-hl-5: #6A9955;
+    --light-hl-4: #008000;
+    --dark-hl-4: #6A9955;
+    --light-hl-5: #098658;
+    --dark-hl-5: #B5CEA8;
     --light-hl-6: #0451A5;
     --dark-hl-6: #9CDCFE;
     --light-hl-7: #001080;

docs/cli/index.html

@@ -44,25 +44,30 @@ <h2 id="available-connectors" class="tsd-anchor-link">Available Connectors<a hre
 <td>Path to the vault file</td>
 </tr>
 <tr>
-<td><code>fileKey</code></td>
-<td>string</td>
-<td>No</td>
-<td><code>~/.smyth/vault.key</code></td>
-<td>Path to the encryption key file</td>
-</tr>
-<tr>
 <td><code>shared</code></td>
 <td>string</td>
 <td>No</td>
-<td><code>&quot;&quot;</code></td>
+<td><code>&quot;default&quot;</code></td>
 <td>Shared team name for cross-team secret access</td>
 </tr>
 </tbody>
 </table>
 <p><strong>Example Configuration:</strong></p>
-<pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">SRE</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@smythos/sre&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">SRE</span><span class="hl-1">.</span><span class="hl-7">init</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-2">Vault:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-2">Connector:</span><span class="hl-1"> </span><span class="hl-3">&#39;JSONFileVault&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">        </span><span class="hl-2">Settings:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-2">file:</span><span class="hl-1"> </span><span class="hl-3">&#39;./secrets/vault.json&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-2">fileKey:</span><span class="hl-1"> </span><span class="hl-3">&#39;./secrets/vault.key&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-2">shared:</span><span class="hl-1"> </span><span class="hl-3">&#39;production&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">        },</span><br/><span class="hl-1">    },</span><br/><span class="hl-1">});</span>
+<pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">SRE</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@smythos/sre&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">SRE</span><span class="hl-1">.</span><span class="hl-7">init</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-2">Vault:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-2">Connector:</span><span class="hl-1"> </span><span class="hl-3">&#39;JSONFileVault&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">        </span><span class="hl-2">Settings:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-2">file:</span><span class="hl-1"> </span><span class="hl-3">&#39;./secrets/vault.json&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-2">shared:</span><span class="hl-1"> </span><span class="hl-3">&#39;production&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">        },</span><br/><span class="hl-1">    },</span><br/><span class="hl-1">});</span>
 </code><button type="button">Copy</button></pre>
 
+<p><strong>vault.json research path:</strong>
+The JSONFileVault connector will search for the vault.json file in the following order:</p>
+<ol>
+<li>The path specified in the <code>file</code> setting</li>
+<li>The <code>.smyth/vault.json</code> file</li>
+<li>The <code>.smyth/vault/vault.json</code> file</li>
+<li>The <code>.smyth/.sre/vault.json</code> file</li>
+<li>The <code>~/.smyth/vault.json</code> file</li>
+<li>The <code>~/.smyth/vault/vault.json</code> file</li>
+<li>The <code>~/.smyth/.sre/vault.json</code> file</li>
+</ol>
+<p>The search paths and the used path are visible in SRE logs in case you need to debug the vault file search.</p>
 <p><strong>Use Cases:</strong></p>
 <ul>
 <li>Development and testing environments</li>

docs/core/documents/05-configuration.html

@@ -10,11 +10,96 @@ There are many ways to contribute to the project beyond writing code. This guide
 
 If you have questions about SmythOS:
 
--   Please visit our official documentation: [https://smythos.com/docs](https://smythos.com/docs)
+-   Please visit our developer documentation: [https://smythos.github.io/sre/](https://smythos.github.io/sre/)
 -   Join our community on Discord: [https://discord.gg/smythos](https://discord.gg/smythos)
 
 ---
 
+## Quick Start
+
+In order to contribute to SmythOS codebase, follow these steps:
+
+1. Fork the repository
+
+```bash
+git clone https://github.com/SmythOS/sre.git
+cd sre
+```
+
+2. Install the dependencies
+
+```bash
+pnpm install
+```
+
+3. Configure sre environment.
+   Smyth Runtime Environment (SRE) expects a directory called .smyth to exist in the root of the project or in the user's home directory.
+   (check [SRE Configuration](https://smythos.github.io/sre/core/documents/05-configuration.html) for more details)
+
+```bash
+mkdir -p .smyth
+#or
+mkdir -p ~/.smyth
+```
+
+And by default the SRE expects this folder to contains a vault.json file with this structure:
+
+```bash
+touch .smyth/vault.json
+#or
+touch ~/.smyth/vault.json
+```
+
+```json
+{
+    "default": {
+        "echo": "",
+        "openai": "<your openai api key>",
+        "anthropic": "<your anthropic api key>",
+        "googleai": "<your google ai api key>",
+        "groq": "<your groq api key>",
+        "togetherai": "<your together ai api key>",
+        "xai": "<your xai api key>",
+        "perplexity": "<your perplexity api key>"
+    }
+}
+```
+
+You don't need to provide all the keys, only the ones you need in your tests.
+
+## 3. Build the project
+
+```bash
+pnpm build
+```
+
+## 4. Run the tests
+
+```bash
+pnpm test
+```
+
+## 5. Run the examples
+
+The project comes with a set of examples that you can run to see the SRE in action.
+
+for this, go to the examples directory and run the following command:
+
+```bash
+pnpm start <path_to_example.ts>
+```
+
+The project also comes with a pre-configured vscode debug launch file for the examples.
+The debugger will allow you to follow breakpoints in the examples and in SRE and SDK codes.
+
+In order to use the debugger :
+
+-   Select "Debug Current Example" from the vscode debug menu.
+-   Open any example .ts file
+-   Then hit F5 to start the debugger
+
+---
+
 ## 💬 Providing Feedback
 
 We welcome all kinds of feedback! Whether you have suggestions, bug reports, or general thoughts, feel free to share them via:
@@ -70,9 +155,10 @@ We love contributions from the community! Here's how to get started:
 SmythOS uses the [Developer Certificate of Origin 1.1](https://developercertificate.org/) to ensure that every
 contribution is made with clear provenance and permission.
 
-- **What you do:** add the `-s` flag to each `git commit`  
-  ```bash
-  git commit -s -m "Fix: correct off-by-one in vector index"
+-   **What you do:** add the `-s` flag to each `git commit`
+    ```bash
+    git commit -s -m "Fix: correct off-by-one in vector index"
+    ```
 
 ---