Implementation:Guardrails ai Guardrails Examples TOC

Knowledge Sources	Guardrails
Domains	Documentation, Configuration
Last Updated	2026-02-14 00:00 GMT

Overview

The examples-toc.json file defines the complete table of contents structure for the Guardrails documentation site, organizing all documentation pages into a hierarchical category and document tree used by Docusaurus.

Description

This JSON configuration file is a Docusaurus sidebar definition that describes the full navigational structure of the Guardrails documentation. It is an array of items where each item is either:

• A category ("type": "category") -- A collapsible grouping with a label and nested items array.
• A document ("type": "doc") -- A leaf node referencing a specific documentation page by its id (relative file path) and display label.

Top-Level Categories

The file organizes documentation into the following major sections:

Category	Description	Notable Documents
Api Reference	Auto-generated API documentation	Async Guard, Guard, Data Types, Errors, History And Logs, Validation Outcome
Api Reference Markdown	Markdown-based API reference	Actions, Guards, Validator, LLM Interaction, Types
Concepts	Core architectural concepts	Guard, Validators, Streaming, Telemetry, Concurrency, Error Remediation
Examples	Worked example notebooks	Bug Free Python Code, Chatbot, Check For PII, Competitors Check, Extracting Entities, Generate Structured Data, Toxic Language, and 24 more
Getting Started	Onboarding documentation	Quickstart, Why Use Guardrails, AI Validation, Contributing
Guardrails AI	Platform-specific docs	Installation, Configuration, Getting Started, FAQ
How To Guides	Task-oriented guides	Custom Validators, Enable Streaming, RAIL, Telemetry, Using LLMs, Deploying AWS
Hub	Guardrails Hub documentation	Introduction, Custom Validator, Input Validation, Multiple Validators, On Fail Policies
Integrations	Third-party integrations	LangChain, LlamaIndex, Azure OpenAI, OpenAI Functions, Grafana Telemetry, MLflow Tracing
Migration Guides	Version upgrade guides	0-2, 0-3, 0-4, 0-5, 0-6 migration guides
Use Cases	Domain-specific tutorials	Text2SQL

Standalone Documents

Several documents exist at the top level outside categories: CLI, Data Types, FAQ, Guardrails Server API, Index, LLM API Wrappers, and The Guard.

Usage

This file is consumed by the Docusaurus documentation framework to generate the sidebar navigation of the Guardrails documentation website. It is maintained manually as documentation pages are added, removed, or reorganized.

Code Reference

Source Location

• Repository: Guardrails
• File: docs/examples-toc.json
• Lines: 1-780

Structure

[
  {
    "type": "category",
    "label": "Category Name",
    "items": [
      {
        "type": "doc",
        "id": "path/to/document",
        "label": "Document Label"
      }
    ],
    "collapsed": true,
    "collapsible": true
  },
  {
    "type": "doc",
    "id": "standalone_document",
    "label": "Standalone Document"
  }
]

Statistics

Metric	Value
Total top-level entries	16
Top-level categories	11
Top-level standalone documents	5
Total example documents	31
Total concept documents	17
Total how-to guide documents	20
Total integration documents	7
File format	JSON (Docusaurus sidebar)

Related Pages

• Principle:Guardrails_ai_Guardrails_Documentation