Skip to content

Commit 538a83f

Browse files
committed
docs polish
1 parent f2824e2 commit 538a83f

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

docs/how_to_guides/logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Inspect Guard Run History and Logs
1+
# Inspect logs from a Guard
22

33
All `Guard` calls are logged internally, and can be accessed via the guard history.
44

docs/how_to_guides/streaming.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"cell_type": "markdown",
1717
"metadata": {},
1818
"source": [
19-
"# Validate Streamed LLM Responses\n"
19+
"# Real-time stream Validated LLM Responses\n"
2020
]
2121
},
2222
{

docs/the_guard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Guard
1+
# What is a Guard?
22

33
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.
44

docusaurus/sidebars.js

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,29 @@ const sidebars = {
3232
},
3333
{
3434
type: "doc",
35-
label: "Installation",
36-
id: "guardrails_ai/installation",
35+
label: "Getting Started",
36+
id: "guardrails_ai/getting_started",
3737
},
3838
{
3939
type: "doc",
40-
label: "Getting Started",
41-
id: "guardrails_ai/getting_started",
40+
label: "Installation",
41+
id: "guardrails_ai/installation",
4242
},
43+
"the_guard",
4344
{
4445
type: "category",
4546
label: "How-to Guides",
4647
collapsed: true,
4748
items: [
48-
"how_to_guides/logs",
49-
"how_to_guides/streaming",
5049
"how_to_guides/llm_api_wrappers",
50+
"how_to_guides/streaming",
51+
"how_to_guides/structured_data_with_guardrails",
52+
"how_to_guides/logs",
5153
"how_to_guides/rail",
5254
"how_to_guides/envvars",
53-
"how_to_guides/structured_data_with_guardrails",
5455
"how_to_guides/telemetry",
5556
],
5657
},
57-
"the_guard",
5858
{
5959
type: "category",
6060
label: "API Reference",
@@ -67,17 +67,17 @@ const sidebars = {
6767
],
6868
},
6969
examples,
70-
{
71-
type: "category",
72-
label: "Integrations",
73-
collapsed: true,
74-
items: [
75-
{
76-
type: "autogenerated",
77-
dirName: "integrations",
78-
},
79-
],
80-
},
70+
// {
71+
// type: "category",
72+
// label: "Integrations",
73+
// collapsed: true,
74+
// items: [
75+
// {
76+
// type: "autogenerated",
77+
// dirName: "integrations",
78+
// },
79+
// ],
80+
// },
8181
{
8282
type: "category",
8383
label: "Migration Guides",

0 commit comments

Comments
 (0)