refactor(docs): update references to new file names where we use hyphens instead of underscore

fix

fix

fix

Author: Pouyanpi

README.md

@@ -26,7 +26,7 @@ NeMo Guardrails is an open-source toolkit for easily adding *programmable guardr
 
 Python 3.9, 3.10 or 3.11.
 
-NeMo Guardrails uses [annoy](https://github.com/spotify/annoy) which is a C++ library with Python bindings. To install NeMo Guardrails you will need to have the C++ compiler and dev tools installed. Check out the [Installation Guide](https://docs.nvidia.com/nemo/guardrails/getting_started/installation-guide.html#prerequisites) for platform-specific instructions.
+NeMo Guardrails uses [annoy](https://github.com/spotify/annoy) which is a C++ library with Python bindings. To install NeMo Guardrails you will need to have the C++ compiler and dev tools installed. Check out the [Installation Guide](https://docs.nvidia.com/nemo/guardrails/getting-started/installation-guide.html#prerequisites) for platform-specific instructions.
 
 ## Installation
 
@@ -36,7 +36,7 @@ To install using pip:
 > pip install nemoguardrails
 ```
 
-For more detailed instructions, see the [Installation Guide](https://docs.nvidia.com/nemo/guardrails/getting_started/installation-guide.html).
+For more detailed instructions, see the [Installation Guide](https://docs.nvidia.com/nemo/guardrails/getting-started/installation-guide.html).
 
 ## Overview
 
@@ -74,7 +74,7 @@ You can use programmable guardrails in different types of use cases:
 
 ### Usage
 
-To add programmable guardrails to your application you can use the Python API or a guardrails server (see the [Server Guide](https://docs.nvidia.com/nemo/guardrails/user_guides/server-guide.html) for more details). Using the Python API is similar to using the LLM directly. Calling the guardrails layer instead of the LLM requires only minimal changes to the code base, and it involves two simple steps:
+To add programmable guardrails to your application you can use the Python API or a guardrails server (see the [Server Guide](https://docs.nvidia.com/nemo/guardrails/user-guides/server-guide.html) for more details). Using the Python API is similar to using the LLM directly. Calling the guardrails layer instead of the LLM requires only minimal changes to the code base, and it involves two simple steps:
 
 1. Loading a guardrails configuration and creating an `LLMRails` instance.
 2. Making the calls to the LLM using the `generate`/`generate_async` methods.
@@ -105,7 +105,7 @@ NeMo Guardrails is an async-first toolkit, which means that the core mechanics a
 
 ### Supported LLMs
 
-You can use NeMo Guardrails with multiple LLMs like OpenAI GPT-3.5, GPT-4, LLaMa-2, Falcon, Vicuna, or Mosaic. For more details, check out the [Supported LLM Models](https://docs.nvidia.com/nemo/guardrails/user_guides/configuration-guide.html#supported-llm-models) section in the Configuration Guide.
+You can use NeMo Guardrails with multiple LLMs like OpenAI GPT-3.5, GPT-4, LLaMa-2, Falcon, Vicuna, or Mosaic. For more details, check out the [Supported LLM Models](https://docs.nvidia.com/nemo/guardrails/user-guides/configuration-guide.html#supported-llm-models) section in the Configuration Guide.
 
 ### Types of Guardrails
 
@@ -117,7 +117,7 @@ NeMo Guardrails supports five main types of guardrails:
 
 1. **Input rails**: applied to the input from the user; an input rail can reject the input, stopping any additional processing, or alter the input (e.g., to mask potentially sensitive data, to rephrase).
 
-2. **Dialog rails**: influence how the LLM is prompted; dialog rails operate on canonical form messages for details see [Colang Guide](https://docs.nvidia.com/nemo/guardrails/user_guides/colang-language-syntax-guide.html)) and determine if an action should be executed, if the LLM should be invoked to generate the next step or a response, if a predefined response should be used instead, etc.
+2. **Dialog rails**: influence how the LLM is prompted; dialog rails operate on canonical form messages for details see [Colang Guide](https://docs.nvidia.com/nemo/guardrails/user-guides/colang-language-syntax-guide.html)) and determine if an action should be executed, if the LLM should be invoked to generate the next step or a response, if a predefined response should be used instead, etc.
 
 3. **Retrieval rails**: applied to the retrieved chunks in the case of a RAG (Retrieval Augmented Generation) scenario; a retrieval rail can reject a chunk, preventing it from being used to prompt the LLM, or alter the relevant chunks (e.g., to mask potentially sensitive data).
 
@@ -141,7 +141,7 @@ The standard structure for a guardrails configuration folder looks like this:
 │   ├── ...
 ```
 
-The `config.yml` contains all the general configuration options, such as LLM models, active rails, and custom configuration data". The `config.py` file contains any custom initialization code and the `actions.py` contains any custom python actions. For a complete overview, see the [Configuration Guide](https://docs.nvidia.com/nemo/guardrails/user_guides/configuration-guide.html).
+The `config.yml` contains all the general configuration options, such as LLM models, active rails, and custom configuration data". The `config.py` file contains any custom initialization code and the `actions.py` contains any custom python actions. For a complete overview, see the [Configuration Guide](https://docs.nvidia.com/nemo/guardrails/user-guides/configuration-guide.html).
 
 Below is an example `config.yml`:
 
@@ -212,30 +212,30 @@ To configure and implement various types of guardrails, this toolkit introduces
 
 **NOTE**: Currently two versions of Colang, 1.0 and 2.0, are supported and Colang 1.0 is the default. Versions 0.1.0 up to 0.7.1 of NeMo Guardrails used Colang 1.0 exclusively. Versions 0.8.0 introduced Colang 2.0-alpha and version 0.9.0 introduced Colang 2.0-beta. We expect Colang 2.0 to go out of Beta and replace 1.0 as the default option in NeMo Guardrails version 0.11.0.
 
-For a brief introduction to the Colang 1.0 syntax, see the [Colang 1.0 Language Syntax Guide](https://docs.nvidia.com/nemo/guardrails/user_guides/colang-language-syntax-guide.html).
+For a brief introduction to the Colang 1.0 syntax, see the [Colang 1.0 Language Syntax Guide](https://docs.nvidia.com/nemo/guardrails/user-guides/colang-language-syntax-guide.html).
 
 To get started with Colang 2.0, see the [Colang 2.0 Documentation](https://docs.nvidia.com/nemo/guardrails/colang_2/overview.html).
 
 ### Guardrails Library
 
-NeMo Guardrails comes with a set of [built-in guardrails](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html).
+NeMo Guardrails comes with a set of [built-in guardrails](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html).
 
 > **NOTE**: The built-in guardrails are only intended to enable you to get started quickly with NeMo Guardrails. For production use cases, further development and testing of the rails are needed.
 
 Currently, the guardrails library includes:
 
-- [Jailbreak Detection](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#jailbreak-detection-heuristics)
-- [Self-Check Input Moderation](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#self-input-output)
-- [Self-Check Output Moderation](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#self-check-output)
-- [Self-Check Fact-checking](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#fact-checking)
-- [Hallucination Detection](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#hallucination-detection)
-- [AlignScore-based Fact-checking](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#alignscore-based-fact-checking)
-- [LlamaGuard-based Content Moderation](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#llama-guard-based-content-moderation)
-- [RAG hallucination detection using Patronus Lynx](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#patronus-lynx-based-rag-hallucination-detection)
-- [Presidio-based Sensitive Data Detection](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#presidio-based-sensitive-data-detection)
-- [Input moderation using ActiveFence](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#activefence)
-- [RAG Hallucination detection using Got It AI's TruthChecker API](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#got-it-ai)
-- [AutoAlign-based guardrails](https://docs.nvidia.com/nemo/guardrails/user_guides/guardrails-library.html#autoalign)
+- [Jailbreak Detection](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#jailbreak-detection-heuristics)
+- [Self-Check Input Moderation](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#self-input-output)
+- [Self-Check Output Moderation](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#self-check-output)
+- [Self-Check Fact-checking](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#fact-checking)
+- [Hallucination Detection](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#hallucination-detection)
+- [AlignScore-based Fact-checking](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#alignscore-based-fact-checking)
+- [LlamaGuard-based Content Moderation](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#llama-guard-based-content-moderation)
+- [RAG hallucination detection using Patronus Lynx](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#patronus-lynx-based-rag-hallucination-detection)
+- [Presidio-based Sensitive Data Detection](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#presidio-based-sensitive-data-detection)
+- [Input moderation using ActiveFence](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#activefence)
+- [RAG Hallucination detection using Got It AI's TruthChecker API](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#got-it-ai)
+- [AutoAlign-based guardrails](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html#autoalign)
 
 ## CLI
 
@@ -284,11 +284,11 @@ Sample output:
 
 #### Docker
 
-To start a guardrails server, you can also use a Docker container. NeMo Guardrails provides a [Dockerfile](./Dockerfile) that you can use to build a `nemoguardrails` image. For further information, see the [using Docker](https://docs.nvidia.com/nemo/guardrails/user_guides/advanced/using-docker.html) section.
+To start a guardrails server, you can also use a Docker container. NeMo Guardrails provides a [Dockerfile](./Dockerfile) that you can use to build a `nemoguardrails` image. For further information, see the [using Docker](https://docs.nvidia.com/nemo/guardrails/user-guides/advanced/using-docker.html) section.
 
 ## Integration with LangChain
 
-NeMo Guardrails integrates seamlessly with LangChain. You can easily wrap a guardrails configuration around a LangChain chain (or any `Runnable`). You can also call a LangChain chain from within a guardrails configuration. For more details, check out the [LangChain Integration Documentation](https://docs.nvidia.com/nemo/guardrails/user_guides/langchain/langchain-integration.html)
+NeMo Guardrails integrates seamlessly with LangChain. You can easily wrap a guardrails configuration around a LangChain chain (or any `Runnable`). You can also call a LangChain chain from within a guardrails configuration. For more details, check out the [LangChain Integration Documentation](https://docs.nvidia.com/nemo/guardrails/user-guides/langchain/langchain-integration.html)
 
 ## Evaluation
 
@@ -309,7 +309,7 @@ To the best of our knowledge, NeMo Guardrails is the only guardrails toolkit tha
 ## Learn More
 
 - [Documentation](https://docs.nvidia.com/nemo/guardrails)
-- [Getting Started Guide](https://docs.nvidia.com/nemo/guardrails/getting_started)
+- [Getting Started Guide](https://docs.nvidia.com/nemo/guardrails/getting-started)
 - [Examples](./examples)
 - [FAQs](https://docs.nvidia.com/nemo/guardrails/faqs.html)
 - [Security Guidelines](https://docs.nvidia.com/nemo/guardrails/security/guidelines.html)

build_notebook_docs.py

@@ -175,7 +175,7 @@ def rename_md_to_readme(start_dir):
             continue
 
         # Skip processing the root directory
-        if path.parent.name == "getting_started":
+        if path.parent.name == "getting-started":
             continue
 
         # Generate the new file name, assuming the path as a directory with README.md

docs/README.md

@@ -13,8 +13,8 @@ The documentation is divided into the following sections:
 
 This section will help you get started quickly with NeMo Guardrails.
 
-* [Installation guide](getting_started/installation-guide.md): This guide walks you through the process of setting up your environment and installing NeMo Guardrails
-* [Getting Started guides](./getting_started): A series of guides that will help you understand the core concepts and build your first guardrails configurations. These guides include Jupyter notebooks that you can experiment with.
+* [Installation guide](getting-started/installation-guide.md): This guide walks you through the process of setting up your environment and installing NeMo Guardrails
+* [Getting Started guides](./getting-started): A series of guides that will help you understand the core concepts and build your first guardrails configurations. These guides include Jupyter notebooks that you can experiment with.
 
 ## Examples
 
@@ -35,16 +35,16 @@ These examples are meant to showcase the process of building rails, not as out-o
 
 The user guides cover the core details of the NeMo Guardrails toolkit and how to configure and use different features to make your own rails.
 
-* [Guardrails Configuration Guide](user_guides/configuration-guide.md): The complete guide to all the configuration options available in the `config.yml` file.
-* [Guardrails Library](user_guides/guardrails-library.md): An overview of the starter built-in rails that NeMo Guardrails provide.
-* [Guardrails Process](user_guides/guardrails-process.md): A detailed description of the guardrails process, i.e., the categories of rails and how they are called.
-* [Colang Language Guide](user_guides/colang-language-syntax-guide.md): Learn the syntax and core concepts of Colang.
-* [LLM Support for Guardrails](user_guides/llm-support.md): An easy to grasp summary of the current LLM support.
-* [Python API](user_guides/python-api.md): Learn about the Python API, e.g., the `RailsConfig` and `LLMRails` classes.
-* [CLI](user_guides/cli.md): Learn about the NeMo Guardrails CLI that can help you use the Chat CLI or start a server.
-* [Server Guide](user_guides/server-guide.md): Learn how to use the NeMo Guardrails server.
-* [Integration with LangChain](user_guides/langchain/langchain-integration.md): Integrate guardrails in your existing LangChain-powered app.
-* [Detailed Logging](user_guides/detailed_logging/README.md): Learn how to get detailed logging information.
+* [Guardrails Configuration Guide](user-guides/configuration-guide.md): The complete guide to all the configuration options available in the `config.yml` file.
+* [Guardrails Library](user-guides/guardrails-library.md): An overview of the starter built-in rails that NeMo Guardrails provide.
+* [Guardrails Process](user-guides/guardrails-process.md): A detailed description of the guardrails process, i.e., the categories of rails and how they are called.
+* [Colang Language Guide](user-guides/colang-language-syntax-guide.md): Learn the syntax and core concepts of Colang.
+* [LLM Support for Guardrails](user-guides/llm-support.md): An easy to grasp summary of the current LLM support.
+* [Python API](user-guides/python-api.md): Learn about the Python API, e.g., the `RailsConfig` and `LLMRails` classes.
+* [CLI](user-guides/cli.md): Learn about the NeMo Guardrails CLI that can help you use the Chat CLI or start a server.
+* [Server Guide](user-guides/server-guide.md): Learn how to use the NeMo Guardrails server.
+* [Integration with LangChain](user-guides/langchain/langchain-integration.md): Integrate guardrails in your existing LangChain-powered app.
+* [Detailed Logging](user-guides/detailed-logging/README.md): Learn how to get detailed logging information.
 
 ## Security
 
@@ -65,19 +65,19 @@ There are also detailed guides on how to reproduce results and create datasets f
 
 The following guides explain in more details various specific topics:
 
-* [Generation Options](user_guides/advanced/generation-options.md): Learn how to have to use advanced generation options.
-* [Prompt Customization](user_guides/advanced/prompt-customization.md): Learn how to customize the prompts for a new (or existing) type of LLM.
-* [Embedding Search Providers](user_guides/advanced/embedding-search-providers.md): Learn about the core embedding search interface that NeMo guardrails uses for some of the core features.
-* [Using Docker](user_guides/advanced/using-docker.md): Learn how to deploy NeMo Guardrails using Docker.
-* [Streaming](user_guides/advanced/streaming.md): Learn about the streaming support in NeMo Guardrails.
-* [AlignScore deployment](user_guides/advanced/align-score-deployment.md): Learn how to deploy an AlignScore server either directly or using Docker.
-* [Extract User-provided Values](user_guides/advanced/extract-user-provided-values.md): Learn how to extract user-provided values like a name, a date or a query.
-* [Bot Message Instructions](user_guides/advanced/bot-message-instructions.md): Learn how to further tweak the bot messages with specific instructions at runtime.
-* [Event-based API](user_guides/advanced/event-based-api.md): Learn about the generic event-based interface that you can use to process additional information in your guardrails configuration.
-* [Jailbreak Detection Heuristics Deployment](user_guides/advanced/jailbreak-detection-heuristics-deployment.md): Learn how to deploy the jailbreak detection heuristics server.
-* [Llama Guard Deployment](user_guides/advanced/llama-guard-deployment.md): Learn how to deploy Llama Guard using vLLM.
-* [Nested AsyncIO Loop](user_guides/advanced/nested-async-loop.md): Understand some of the low level issues regarding `asyncio` and how they are handled in NeMo Guardrails.
-* [Vertex AI Setup](user_guides/advanced/vertexai-setup.md): Learn how to setup a Vertex AI account.
+* [Generation Options](user-guides/advanced/generation-options.md): Learn how to have to use advanced generation options.
+* [Prompt Customization](user-guides/advanced/prompt-customization.md): Learn how to customize the prompts for a new (or existing) type of LLM.
+* [Embedding Search Providers](user-guides/advanced/embedding-search-providers.md): Learn about the core embedding search interface that NeMo guardrails uses for some of the core features.
+* [Using Docker](user-guides/advanced/using-docker.md): Learn how to deploy NeMo Guardrails using Docker.
+* [Streaming](user-guides/advanced/streaming.md): Learn about the streaming support in NeMo Guardrails.
+* [AlignScore deployment](user-guides/advanced/align-score-deployment.md): Learn how to deploy an AlignScore server either directly or using Docker.
+* [Extract User-provided Values](user-guides/advanced/extract-user-provided-values.md): Learn how to extract user-provided values like a name, a date or a query.
+* [Bot Message Instructions](user-guides/advanced/bot-message-instructions.md): Learn how to further tweak the bot messages with specific instructions at runtime.
+* [Event-based API](user-guides/advanced/event-based-api.md): Learn about the generic event-based interface that you can use to process additional information in your guardrails configuration.
+* [Jailbreak Detection Heuristics Deployment](user-guides/advanced/jailbreak-detection-heuristics-deployment.md): Learn how to deploy the jailbreak detection heuristics server.
+* [Llama Guard Deployment](user-guides/advanced/llama-guard-deployment.md): Learn how to deploy Llama Guard using vLLM.
+* [Nested AsyncIO Loop](user-guides/advanced/nested-async-loop.md): Understand some of the low level issues regarding `asyncio` and how they are handled in NeMo Guardrails.
+* [Vertex AI Setup](user-guides/advanced/vertexai-setup.md): Learn how to setup a Vertex AI account.
 
 
 ## Other