From 24655a9519a94cb4073af177cc09eece9ae40ed6 Mon Sep 17 00:00:00 2001 From: Nicholas Chen Date: Tue, 20 Aug 2024 15:10:52 -0400 Subject: [PATCH 1/3] iudex link --- docusaurus/sidebars.js | 90 ++++++++++++++++++++++++------------------ 1 file changed, 51 insertions(+), 39 deletions(-) diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index f695a0797..b3210f3e9 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -27,48 +27,48 @@ const sidebars = { // tutorialSidebar: [{ type: "autogenerated", dirName: "." }], docs: [ "index", - "getting_started/quickstart", + "docs/getting_started/quickstart", // "getting_started/why_use", // "getting_started/ai_validation", // "getting_started/ml_based", // "getting_started/structured_data", - "getting_started/guardrails_server", - "getting_started/contributing", - "getting_started/help", + "docs/getting_started/guardrails_server", + "docs/getting_started/contributing", + "docs/getting_started/help", "faq", { type: "category", label: "Migration Guides", collapsed: false, items: [ - "migration_guides/0-5-migration", + // "migration_guides/0-5-migration", "migration_guides/0-4-migration", "migration_guides/0-3-migration", "migration_guides/0-2-migration", - ] - } + ], + }, ], concepts: [ - "concepts/guard", - "concepts/validators", + "docs/concepts/guard", + "docs/concepts/validators", // "concepts/guardrails", - "concepts/hub", - "concepts/deploying", - "concepts/remote_validation_inference", + "docs/concepts/hub", + "docs/concepts/deploying", + "docs/concepts/remote_validation_inference", { type: "category", label: "Streaming", collapsed: false, items: [ - "concepts/streaming", - "concepts/async_streaming", - "concepts/streaming_structured_data", + "docs/concepts/streaming", + "docs/concepts/async_streaming", + "docs/concepts/streaming_structured_data", ], }, - "concepts/parallelization", - "concepts/logs", - "concepts/telemetry", - "concepts/error_remediation", + "docs/concepts/parallelization", + "docs/concepts/logs", + "docs/concepts/telemetry", + "docs/concepts/error_remediation", ], tutorials: [ { @@ -76,31 +76,30 @@ const sidebars = { label: "How-to Guides", collapsed: false, items: [ - "how_to_guides/using_llms", - "how_to_guides/enable_streaming", - "how_to_guides/generate_structured_data", - "how_to_guides/custom_validators", - "how_to_guides/hosting_validator_models", - "how_to_guides/hosting_with_docker", - "how_to_guides/deploying_aws", - ] - }, { + "docs/how_to_guides/using_llms", + "docs/how_to_guides/enable_streaming", + "docs/how_to_guides/generate_structured_data", + "docs/how_to_guides/custom_validators", + "docs/how_to_guides/hosting_validator_models", + "docs/how_to_guides/hosting_with_docker", + "docs/how_to_guides/deploying_aws", + ], + }, + { type: "category", label: "Sample Apps", collapsed: false, - items: [ - "examples/chatbot", - "examples/summarizer", - ] - }, { + items: ["docs/examples/chatbot", "docs/examples/summarizer"], + }, + { type: "link", label: "More Examples", href: "https://github.com/guardrails-ai/guardrails/tree/main/docs/examples", - } + }, ], integrations: [ // "integrations/azure_openai", - "integrations/langchain", + "docs/integrations/langchain", { type: "category", label: "Telemetry", @@ -111,7 +110,20 @@ const sidebars = { label: "Arize AI", href: "https://docs.arize.com/arize/large-language-models/guardrails", }, - "integrations/telemetry/grafana", + "docs/integrations/telemetry/grafana", + ], + }, + { + type: "category", + label: "Telemetry", + collapsed: false, + items: [ + { + type: "link", + label: "Iudex", + href: "https://docs.iudex.ai/integrations/guardrails-integration", + }, + "docs/integrations/telemetry/grafana", ], }, @@ -129,9 +141,9 @@ const sidebars = { }, ], }, - "guardrails_server_api", - "cli" - ] + "docs/guardrails_server_api", + "docs/cli", + ], }; module.exports = sidebars; From f30744f31ca3867acfa7dc60fbb91a2d7f7efae6 Mon Sep 17 00:00:00 2001 From: Nicholas Chen Date: Tue, 20 Aug 2024 16:39:54 -0400 Subject: [PATCH 2/3] docs --- docusaurus/sidebars.js | 58 +++++++++++++++++++++--------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index b3210f3e9..2a7d4564f 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -27,14 +27,14 @@ const sidebars = { // tutorialSidebar: [{ type: "autogenerated", dirName: "." }], docs: [ "index", - "docs/getting_started/quickstart", + "getting_started/quickstart", // "getting_started/why_use", // "getting_started/ai_validation", // "getting_started/ml_based", // "getting_started/structured_data", - "docs/getting_started/guardrails_server", - "docs/getting_started/contributing", - "docs/getting_started/help", + "getting_started/guardrails_server", + "getting_started/contributing", + "getting_started/help", "faq", { type: "category", @@ -49,26 +49,26 @@ const sidebars = { }, ], concepts: [ - "docs/concepts/guard", - "docs/concepts/validators", + "concepts/guard", + "concepts/validators", // "concepts/guardrails", - "docs/concepts/hub", - "docs/concepts/deploying", - "docs/concepts/remote_validation_inference", + "concepts/hub", + "concepts/deploying", + "concepts/remote_validation_inference", { type: "category", label: "Streaming", collapsed: false, items: [ - "docs/concepts/streaming", - "docs/concepts/async_streaming", - "docs/concepts/streaming_structured_data", + "concepts/streaming", + "concepts/async_streaming", + "concepts/streaming_structured_data", ], }, - "docs/concepts/parallelization", - "docs/concepts/logs", - "docs/concepts/telemetry", - "docs/concepts/error_remediation", + "concepts/parallelization", + "concepts/logs", + "concepts/telemetry", + "concepts/error_remediation", ], tutorials: [ { @@ -76,20 +76,20 @@ const sidebars = { label: "How-to Guides", collapsed: false, items: [ - "docs/how_to_guides/using_llms", - "docs/how_to_guides/enable_streaming", - "docs/how_to_guides/generate_structured_data", - "docs/how_to_guides/custom_validators", - "docs/how_to_guides/hosting_validator_models", - "docs/how_to_guides/hosting_with_docker", - "docs/how_to_guides/deploying_aws", + "how_to_guides/using_llms", + "how_to_guides/enable_streaming", + "how_to_guides/generate_structured_data", + "how_to_guides/custom_validators", + "how_to_guides/hosting_validator_models", + "how_to_guides/hosting_with_docker", + "how_to_guides/deploying_aws", ], }, { type: "category", label: "Sample Apps", collapsed: false, - items: ["docs/examples/chatbot", "docs/examples/summarizer"], + items: ["examples/chatbot", "examples/summarizer"], }, { type: "link", @@ -99,7 +99,7 @@ const sidebars = { ], integrations: [ // "integrations/azure_openai", - "docs/integrations/langchain", + "integrations/langchain", { type: "category", label: "Telemetry", @@ -110,7 +110,7 @@ const sidebars = { label: "Arize AI", href: "https://docs.arize.com/arize/large-language-models/guardrails", }, - "docs/integrations/telemetry/grafana", + "integrations/telemetry/grafana", ], }, { @@ -123,7 +123,7 @@ const sidebars = { label: "Iudex", href: "https://docs.iudex.ai/integrations/guardrails-integration", }, - "docs/integrations/telemetry/grafana", + "integrations/telemetry/grafana", ], }, @@ -141,8 +141,8 @@ const sidebars = { }, ], }, - "docs/guardrails_server_api", - "docs/cli", + "guardrails_server_api", + "cli", ], }; From 06ced7143eacddda7ffcc11258b72ea97b727359 Mon Sep 17 00:00:00 2001 From: Nicholas Chen Date: Tue, 20 Aug 2024 16:40:33 -0400 Subject: [PATCH 3/3] uncomment migration --- docusaurus/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index 2a7d4564f..c47a188fc 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -41,7 +41,7 @@ const sidebars = { label: "Migration Guides", collapsed: false, items: [ - // "migration_guides/0-5-migration", + "migration_guides/0-5-migration", "migration_guides/0-4-migration", "migration_guides/0-3-migration", "migration_guides/0-2-migration",