fix links to notebooks

.github/workflows/scripts/run_notebooks.sh

@@ -5,7 +5,7 @@ export NLTK_DATA=/tmp/nltk_data;
 rm -rf ./guardrails
 
 # Navigate to notebooks
-cd docs/examples
+cd docs/src/examples
 
 # Get the notebook name from the matrix variable
 notebook="$1"

.github/workflows/scripts/update_notebook_matrix.sh

@@ -3,7 +3,7 @@
 notebook_names="["
 
 # Compile list of file names
-for file in $(ls docs/examples/*.ipynb); do
+for file in $(ls docs/src/examples/*.ipynb); do
   # Add the full filename with extension
   filename=$(basename "$file")
 

docs/dist/examples/bug_free_python_code.ipynb

@@ -8,7 +8,7 @@
     "# Generating Bug Free Leetcode Solutions\n",
     "\n",
     ":::note\n",
-    "To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/bug_free_python_code.ipynb).\n",
+    "To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/bug_free_python_code.ipynb).\n",
     ":::\n",
     "\n",
     "In this example, we want to solve String Manipulation leetcode problems such that the code is bug free.\n",

docs/dist/examples/bug_free_python_code.md

@@ -3,7 +3,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 # Generating Bug Free Leetcode Solutions
 
 :::note
-To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/bug_free_python_code.ipynb).
+To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/bug_free_python_code.ipynb).
 :::
 
 In this example, we want to solve String Manipulation leetcode problems such that the code is bug free.

docs/dist/examples/chatbot.ipynb

@@ -44,7 +44,7 @@
    "source": [
     "### Step 0 Download PDF and load it as string\n",
     ":::note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/chatbots.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/chatbots.ipynb).\n",
     ":::\n",
     "\n",
     "In this example, we will set up Guardrails with a chat model that can answer questions about the card agreement."

docs/dist/examples/chatbot.md

@@ -33,7 +33,7 @@ guardrails hub install hub://guardrails/profanity_free --quiet
 
 ### Step 0 Download PDF and load it as string
 :::note
-    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/chatbots.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/chatbots.ipynb).
 :::
 
 In this example, we will set up Guardrails with a chat model that can answer questions about the card agreement.

docs/dist/examples/competitors_check.ipynb

@@ -7,7 +7,7 @@
     "# Check if a competitor is named\n",
     "\n",
     "!!! note\n",
-    "To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/competitors_check.ipynb).\n"
+    "To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/competitors_check.ipynb).\n"
    ]
   },
   {

docs/dist/examples/competitors_check.md

@@ -3,7 +3,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 # Check if a competitor is named
 
 !!! note
-To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/competitors_check.ipynb).
+To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/competitors_check.ipynb).
 
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! Instead, edit the notebook w/the location & name as this file. -->

docs/dist/examples/extracting_entities.ipynb

@@ -52,7 +52,7 @@
     "# Extracting entities from a Terms of Service document\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/extracting_entities.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/extracting_entities.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails to extract key information from a Terms-of-Service document.\n",
     "\n",
@@ -62,7 +62,7 @@
     "\n",
     "## Step 0: Download PDF and load it as string\n",
     "\n",
-    "To get started, download the document from [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.\n",
+    "To get started, download the document from [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.\n",
     "\n",
     "Guardrails has some built-in functions to help with common tasks. Here, we will use the `read_pdf` function to load the PDF as a string."
    ]

docs/dist/examples/extracting_entities.md

@@ -44,7 +44,7 @@ guardrails hub install hub://guardrails/one_line --quiet
 # Extracting entities from a Terms of Service document
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/extracting_entities.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/extracting_entities.ipynb).
 
 In this example, we will use Guardrails to extract key information from a Terms-of-Service document.
 
@@ -54,7 +54,7 @@ We want to extract structured information about all fees and interest rates asso
 
 ## Step 0: Download PDF and load it as string
 
-To get started, download the document from [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.
+To get started, download the document from [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.
 
 Guardrails has some built-in functions to help with common tasks. Here, we will use the `read_pdf` function to load the PDF as a string.
 

docs/dist/examples/guardrails_with_chat_models.ipynb

@@ -42,7 +42,7 @@
     "# Using Guardrails with Chat Models\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/extracting_entities.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/extracting_entities.ipynb).\n",
     "\n",
     "In this example, we will set up Guardrails with a chat model.\n",
     "\n",
@@ -52,7 +52,7 @@
     "\n",
     "## Step 0: Download PDF and load it as string\n",
     "\n",
-    "To get started, download the document from [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.\n",
+    "To get started, download the document from [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.\n",
     "\n",
     "Guardrails has some built-in functions to help with common tasks. Here, we will use the `read_pdf` function to load the PDF as a string."
    ]

docs/dist/examples/guardrails_with_chat_models.md

@@ -36,7 +36,7 @@ guardrails hub install hub://guardrails/one_line --quiet
 # Using Guardrails with Chat Models
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/extracting_entities.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/extracting_entities.ipynb).
 
 In this example, we will set up Guardrails with a chat model.
 
@@ -46,7 +46,7 @@ We retry the [entity extraction example](./extracting_entities.ipynb) using a ch
 
 ## Step 0: Download PDF and load it as string
 
-To get started, download the document from [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.
+To get started, download the document from [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/data/chase_card_agreement.pdf) and save it in `data/chase_card_agreement.pdf`.
 
 Guardrails has some built-in functions to help with common tasks. Here, we will use the `read_pdf` function to load the PDF as a string.
 

docs/dist/examples/no_secrets_in_generated_text.ipynb

@@ -8,7 +8,7 @@
     "# Generating strings that don't have any secrets\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/no_secrets_in_generated_text.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/no_secrets_in_generated_text.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails to generate strings that don't have any secrets.\n",
     "\n",

docs/dist/examples/no_secrets_in_generated_text.md

@@ -3,7 +3,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 # Generating strings that don't have any secrets
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/no_secrets_in_generated_text.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/no_secrets_in_generated_text.ipynb).
 
 In this example, we will use Guardrails to generate strings that don't have any secrets.
 

docs/dist/examples/recipe_generation.ipynb

@@ -8,7 +8,7 @@
     "# Generating Vegan Recipes\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/recipe_generation.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/recipe_generation.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails to generate vegan mac and cheese recipe.\n",
     "\n",

docs/dist/examples/recipe_generation.md

@@ -3,7 +3,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 # Generating Vegan Recipes
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/recipe_generation.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/recipe_generation.ipynb).
 
 In this example, we will use Guardrails to generate vegan mac and cheese recipe.
 

docs/dist/examples/select_choice_based_on_action.ipynb

@@ -27,7 +27,7 @@
     "# Enforcing Guardrails on Choice Selection\n",
     "\n",
     "!!! note\n",
-    "    To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/select_choice_based_on_action.ipynb).\n",
+    "    To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/select_choice_based_on_action.ipynb).\n",
     "\n",
     "In this example, we want the LLM to pick an action (e.g. `fight` or `flight`), and based on that action we want to return different JSON objects. For example, if the action is `fight`, we want to return a JSON object that contains the `weapon` field. If the action is `flight`, we want to return a JSON object that contains the `direction` and `distance` fields.\n",
     "\n",

docs/dist/examples/select_choice_based_on_action.md

@@ -20,7 +20,7 @@ guardrails hub install hub://guardrails/valid_choices --quiet
 # Enforcing Guardrails on Choice Selection
 
 !!! note
-    To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/select_choice_based_on_action.ipynb).
+    To download this tutorial as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/select_choice_based_on_action.ipynb).
 
 In this example, we want the LLM to pick an action (e.g. `fight` or `flight`), and based on that action we want to return different JSON objects. For example, if the action is `fight`, we want to return a JSON object that contains the `weapon` field. If the action is `flight`, we want to return a JSON object that contains the `direction` and `distance` fields.
 

docs/dist/examples/summarizer.ipynb

@@ -9,7 +9,7 @@
     "In this example we will use Guardrails to summarize text in terms of length, quality and output read time.\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/summarization.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/summarization.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails in the summarization of a text document. We will check whether the summarized document has a high semantic similarity with the original document. We will ensure the ouptput meets a certain range of length and read time.\n",
     "\n",

docs/dist/examples/summarizer.md

@@ -5,7 +5,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 In this example we will use Guardrails to summarize text in terms of length, quality and output read time.
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/summarization.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/summarization.ipynb).
 
 In this example, we will use Guardrails in the summarization of a text document. We will check whether the summarized document has a high semantic similarity with the original document. We will ensure the ouptput meets a certain range of length and read time.
 

docs/dist/examples/syntax_error_free_sql.ipynb

@@ -28,7 +28,7 @@
     "# Natural Language to Bug Free SQL\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/syntax_error_free_sql.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/syntax_error_free_sql.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails to generate SQL queries from natural language. We will check that the SQL is free of any syntax errors.\n",
     "\n",

docs/dist/examples/syntax_error_free_sql.md

@@ -20,7 +20,7 @@ guardrails hub install hub://guardrails/valid_sql --quiet
 # Natural Language to Bug Free SQL
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/syntax_error_free_sql.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/syntax_error_free_sql.ipynb).
 
 In this example, we will use Guardrails to generate SQL queries from natural language. We will check that the SQL is free of any syntax errors.
 

docs/dist/examples/text_summarization_quality.ipynb

@@ -28,7 +28,7 @@
     "# Summarize text accurately\n",
     "\n",
     ":::note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/text_summarization_quality.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/text_summarization_quality.ipynb).\n",
     ":::\n",
     "\n",
     "In this example, we will use Guardrails in the summarization of a text document. We will check whether the summarized document has a high semantic similarity with the original document.\n",

docs/dist/examples/text_summarization_quality.md

@@ -20,7 +20,7 @@ guardrails hub install hub://guardrails/similar_to_document --quiet
 # Summarize text accurately
 
 :::note
-    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/text_summarization_quality.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/text_summarization_quality.ipynb).
 :::
 
 In this example, we will use Guardrails in the summarization of a text document. We will check whether the summarized document has a high semantic similarity with the original document.

docs/dist/examples/translation_to_specific_language.ipynb

@@ -8,7 +8,7 @@
     "# Translate text without profanities\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/translation_to_specific_language.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/translation_to_specific_language.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails during the translation of a statement from another language to english. We will check whether the translated statement passes the profanity check or not.\n",
     "\n",

docs/dist/examples/translation_to_specific_language.md

@@ -3,7 +3,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 # Translate text without profanities
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/examples/translation_to_specific_language.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/ShreyaR/guardrails/blob/main/docs/src/examples/translation_to_specific_language.ipynb).
 
 In this example, we will use Guardrails during the translation of a statement from another language to english. We will check whether the translated statement passes the profanity check or not.
 

docs/dist/examples/translation_with_quality_check.ipynb

@@ -43,7 +43,7 @@
     "# Translate text with quality checks\n",
     "\n",
     "**Note:**\n",
-    "To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/translation_with_quality_check.ipynb).\n",
+    "To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/translation_with_quality_check.ipynb).\n",
     "\n",
     "In this example, we will use Guardrails during the translation of a statement from another language to English. We will check whether the translated statement is likely of high quality.\n",
     "\n",

docs/dist/examples/translation_with_quality_check.md

@@ -35,7 +35,7 @@ guardrails hub install hub://brainlogic/high_quality_translation -q
 # Translate text with quality checks
 
 **Note:**
-To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/translation_with_quality_check.ipynb).
+To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/translation_with_quality_check.ipynb).
 
 In this example, we will use Guardrails during the translation of a statement from another language to English. We will check whether the translated statement is likely of high quality.
 

docs/dist/examples/valid_chess_moves.ipynb

@@ -8,7 +8,7 @@
     "# Playing Valid Chess Moves\n",
     "\n",
     "!!! note\n",
-    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/valid_chess_moves.ipynb).\n",
+    "    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/valid_chess_moves.ipynb).\n",
     "\n",
     "!!! warning\n",
     "    This example is currently under development (it cannot be used to play a full chess game yet).\n",

docs/dist/examples/valid_chess_moves.md

@@ -3,7 +3,7 @@ import CodeOutputBlock from '../../code-output-block.jsx';
 # Playing Valid Chess Moves
 
 !!! note
-    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/examples/valid_chess_moves.ipynb).
+    To download this example as a Jupyter notebook, click [here](https://github.com/guardrails-ai/guardrails/blob/main/docs/src/examples/valid_chess_moves.ipynb).
 
 !!! warning
     This example is currently under development (it cannot be used to play a full chess game yet).