Merge pull request #638 from guardrails-ai/shreya/docs-polish

Polish docs sidebars and page names

Author: CalebCourier

docs/how_to_guides/envvars.md

@@ -1,6 +1,6 @@
-# Set API Keys and other Environment Variables
+# Set API Keys and other EnvVars
 
-Guardrails recognize a handful of environment variables that can be used at runtime.  Most of these correlate to envinronment variables used or expected by the various LLM clients.  Below you can find a list of these and their uses.
+Guardrails recognizes a handful of environment variables that can be used at runtime.  Most of these correlate to environment variables used or expected by the various LLM clients.  Below you can find a list of these and their uses.
 
 ### `OPENAI_API_KEY`
 This environment variable can be used to set your api key credentials for Open AI models.  It will be used wherever Open AI is called if an api_key kwarg is not passed to `__call__` or `parse`.

docs/how_to_guides/llm_api_wrappers.md

@@ -1,7 +1,7 @@
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Use Guardrails with any LLMs
+# Use Guardrails with any LLM
 
 Guardrails' `Guard` wrappers provide a simple way to add Guardrails to your LLM API calls. The wrappers are designed to be used with any LLM API.
 

docs/how_to_guides/logs.md

@@ -1,4 +1,4 @@
-# Inspect Guard Run History and Logs
+# Inspect logs from a Guard
 
 All `Guard` calls are logged internally, and can be accessed via the guard history.
 

docs/how_to_guides/rail.md

@@ -1,4 +1,4 @@
-# Use Guardrails with Markup
+# Use Guardrails via RAIL
 
 ## What is `RAIL`?
 

docs/how_to_guides/streaming.ipynb

@@ -1,22 +1,10 @@
 {
  "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!guardrails hub install hub://guardrails/valid_range\n",
-    "!guardrails hub install hub://guardrails/uppercase\n",
-    "!guardrails hub install hub://guardrails/lowercase\n",
-    "!guardrails hub install hub://guardrails/one_line"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Validate Streamed LLM Responses\n"
+    "# Stream-validate LLM responses\n"
    ]
   },
   {
@@ -33,6 +21,22 @@
     "import time"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Setup\n",
+    "\n",
+    "Install the necessary validators from Guardrails hub in your CLI.\n",
+    "\n",
+    "```bash\n",
+    "!guardrails hub install hub://guardrails/valid_range\n",
+    "!guardrails hub install hub://guardrails/uppercase\n",
+    "!guardrails hub install hub://guardrails/lowercase\n",
+    "!guardrails hub install hub://guardrails/one_line\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

docs/how_to_guides/structured_data_with_guardrails.mdx

@@ -1,7 +1,7 @@
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Generate structured data with Guardrails AI
+# Generate structured data
 
 Guardrails AI is effective for generating structured data across from a variety of LLMs. This guide contains 
 the following:

docs/the_guard.md

@@ -1,4 +1,4 @@
-# The Guard
+# What is a Guard?
 
 The guard object is the main interface for GuardRails. It is seeded with a RailSpec, and then used to run the GuardRails AI engine. It is the object that accepts changing prompts, wraps LLM prompts, and keeps track of call history.
 

docusaurus/sidebars.js

@@ -32,29 +32,29 @@ const sidebars = {
     },
     {
       type: "doc",
-      label: "Installation",
-      id: "guardrails_ai/installation",
+      label: "Getting Started",
+      id: "guardrails_ai/getting_started",
     },
     {
       type: "doc",
-      label: "Getting Started",
-      id: "guardrails_ai/getting_started",
+      label: "Installation",
+      id: "guardrails_ai/installation",
     },
+    "the_guard",
     {
       type: "category",
       label: "How-to Guides",
       collapsed: true,
       items: [
-        "how_to_guides/logs",
-        "how_to_guides/streaming",
         "how_to_guides/llm_api_wrappers",
+        "how_to_guides/streaming",
+        "how_to_guides/structured_data_with_guardrails",
+        "how_to_guides/logs",
         "how_to_guides/rail",
         "how_to_guides/envvars",
-        "how_to_guides/structured_data_with_guardrails",
         "how_to_guides/telemetry",
       ],
     },
-    "the_guard",
     {
       type: "category",
       label: "API Reference",
@@ -67,21 +67,21 @@ const sidebars = {
       ],
     },
     examples,
-    {
-      type: "category",
-      label: "Integrations",
-      collapsed: true,
-      items: [
-        {
-          type: "autogenerated",
-          dirName: "integrations",
-        },
-      ],
-    },
+    // {
+    //   type: "category",
+    //   label: "Integrations",
+    //   collapsed: true,
+    //   items: [
+    //     {
+    //       type: "autogenerated",
+    //       dirName: "integrations",
+    //     },
+    //   ],
+    // },
     {
       type: "category",
       label: "Migration Guides",
-      collapsed: false,
+      collapsed: true,
       items: [
         "migration_guides/0-4-migration",
         "migration_guides/0-3-migration",