merge documentation

Author: lbeurerkellner

README.md

@@ -5,12 +5,7 @@ Documentation for the Invariant SDK.
 To locally serve a live version of the documentation, run the following command in this directory:
 
 ```bash
-docker build -t invariant-docs .
-docker run -it -p 8000:8000 -e DEV_MODE=true -v .:/docs/ invariant-docs 
+./dev serve
 ```
 
-With `DEV_MODE=true` and the mounted volume, the documentation will reflect changes made to the markdown files in real-time.
-
-For deployment, we build the Docker image and push it to the registry:
-
-The actual documentation can be found in the subfolder `docs/`.
+**Requirements:** Docker

dev

@@ -0,0 +1,26 @@
+#!/usr/bin/python3
+# ./do build
+# docker build -t invariant-docs .
+# ./do serve
+# docker build -t invariant-docs . && docker run -it -p 8000:8000 -e DEV_MODE=true -v .:/docs/ invariant-docs
+
+import sys
+import time
+import subprocess
+import webbrowser
+
+if sys.argv[1] == 'build':
+    print('Building image...')
+    subprocess.run(['docker', 'build', '-t', 'invariant-docs', '.'])
+elif sys.argv[1] == 'serve':
+    print('Building image...')
+    p = subprocess.Popen(['docker', 'build', '-t', 'invariant-docs', '.'], stdout=subprocess.PIPE)
+    p.wait()
+    print('Starting server...')
+    p = subprocess.Popen("docker run -it -p 8000:8000 -e DEV_MODE=true -v .:/docs/ invariant-docs", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    time.sleep(1)
+    webbrowser.open('http://localhost:8000')
+    p.wait()
+else:
+    print('Usage: ./do build | ./do serve')
+    sys.exit(1)

docs/assets/invariant.css

@@ -213,6 +213,7 @@ blockquote {
     overflow: hidden;
     color: black;
     margin-top: 30pt !important;
+    padding-top: 5pt;
 }
 
 blockquote pre {
@@ -241,8 +242,8 @@ h2, h3, h4 {
 
 h2 {
     border-top: 1pt solid #e5e5e58e;
-    padding-top: 30pt;
-    margin-top: 30pt !important;
+    padding-top: 10pt;
+    margin-top: 20pt !important;
 }
 
 h5 {
@@ -279,13 +280,81 @@ h5 span.optional:after {
     display: inline-block;
 }
 
-ul {
-    margin-top: 0pt !important;
-    list-style-type: none !important;
-}
 
 /* p when preceded by h5 */
 h5 + p, h5 + p + p, h5 + p + p + p, h5 + p + p + p + p {
     font-size: 12pt !important;
     margin-top: -5pt !important;
+}
+
+a {
+    text-decoration: underline;
+}
+
+.md-nav__list a, .tiles a {
+    text-decoration: none;
+}
+
+.jupyter-wrapper .jp-InputArea-editor {
+    /* border-radius: 5pt; */
+    border: none !important;
+}
+
+.jupyter-wrapper .jp-InputArea-editor {
+    padding: 5pt;
+}
+
+.jupyter-wrapper .jp-InputArea-editor pre {
+    font-size: 12pt;
+}
+
+.jupyter-wrapper .jp-InputPrompt, .jupyter-wrapper .jp-CodeCell .jp-Cell-inputWrapper .jp-InputPrompt {
+    display: none !important;
+}
+
+.jupyter-wrapper .jp-Notebook .jp-Cell:not(.jp-mod-active) .jp-OutputPrompt {
+    display: none !important;
+}
+
+/* output font size larger */
+.jupyter-wrapper .jp-RenderedText.jp-OutputArea-output pre {
+    font-size: 12pt;
+    border-left: 4pt solid #3d3aff4d;
+    padding-left: 8pt;
+}
+
+.jupyter-wrapper .jp-Cell-inputArea, .jupyter-wrapper .jp-Cell-outputArea {
+    margin-top: 10pt;
+}
+
+/* do not show stderr */
+.jupyter-wrapper .jp-RenderedText.jp-OutputArea-output[data-mime-type="application/vnd.jupyter.stderr"] {
+    display: none !important;
+}
+
+div.highlight {
+    font-size: 12pt !important;
+}
+
+span.llm::before {
+    content: "LLM-based";
+    color: white;
+    font-size: 8pt;
+    position: relative;
+    top: -3pt;
+    margin-left: 3pt;
+    background-color: rgb(199, 130, 199);
+    display: inline-block;
+    height: 10pt;
+    
+    padding: 2pt 4pt;
+    border-radius: 4pt;
+}
+
+.jupyter-wrapper {
+    margin-top: -20pt;
+}
+
+label.md-nav__title {
+    display: none;
 }

docs/Explorer_API/1_client_setup.md …/explorer/Explorer_API/1_client_setup.mddocs/Explorer_API/1_client_setup.md renamed to docs/explorer/Explorer_API/1_client_setup.md docs/Explorer_API/1_client_setup.md renamed to docs/explorer/Explorer_API/1_client_setup.md

@@ -3,7 +3,7 @@
 The SDK exposes a `Client` class. To create an object of this type, you need two variables: the Invariant API endpoint URL and the API key.
 
 ## Getting the API Key
-Navigate to the <img class='inline-invariant' src="../assets/logo.svg"/> [Invariant Explorer](https://explorer.invariantlabs.ai) and create an account via GitHub Sign-In.
+Navigate to the <img class='inline-invariant' src="../../assets/logo.svg"/> [Invariant Explorer](https://explorer.invariantlabs.ai) and create an account via GitHub Sign-In.
 
 Once you have created an account, go to your [User Settings](https://explorer.invariantlabs.ai/settings) and generate an API key.
 

docs/Explorer_API/2_traces.md docs/explorer/Explorer_API/2_traces.mddocs/Explorer_API/2_traces.md renamed to docs/explorer/Explorer_API/2_traces.md

@@ -8,7 +8,7 @@ Annotations provide additional context, facilitating collaboration and agent err
 
 <figure class='wide'>
 
-<img src="../assets/annotated-trace.png" alt="An annotated trace" style="width: 100%;">
+<img src="../../assets/annotated-trace.png" alt="An annotated trace" style="width: 100%;">
 
 <figcaption>An annotated trace in Explorer</figcaption>