Merge pull request #881 from NVIDIA/fix/colang-2-doc-folder-renaming

Update underscore folder names to new hyphen format

Author: schuellc-nvidia

.vscode/settings.json

@@ -46,7 +46,7 @@
     "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
         "${workspaceFolder}/tests",
-        "${workspaceFolder}/docs/colang_2/examples"
+        "${workspaceFolder}/docs/colang-2/examples"
     ],
     "python.testing.unittestEnabled": false,
     //"python.envFile": "${workspaceFolder}/python_release.env",

CHANGELOG-Colang.md

@@ -88,7 +88,7 @@ Other:
 
 ### Added
 
-* [Standard library of flows](https://docs.nvidia.com/nemo/guardrails/colang_2/language_reference/the-standard-library.html): `core.co`, `llm.co`, `guardrails.co`, `avatars.co`, `timing.co`, `utils.co`.
+* [Standard library of flows](https://docs.nvidia.com/nemo/guardrails/colang-2/language-reference/the-standard-library.html): `core.co`, `llm.co`, `guardrails.co`, `avatars.co`, `timing.co`, `utils.co`.
 
 ### Changed
 
@@ -125,7 +125,7 @@ Other:
 
 ## [2.0-alpha] - 2024-02-28
 
-[Colang 2.0](https://docs.nvidia.com/nemo/guardrails/colang_2/overview.html) represents a complete overhaul of both the language and runtime. Key enhancements include:
+[Colang 2.0](https://docs.nvidia.com/nemo/guardrails/colang-2/overview.html) represents a complete overhaul of both the language and runtime. Key enhancements include:
 
 ### Added
 

CHANGELOG.md

@@ -170,7 +170,7 @@ The changes related to the Colang language and runtime have moved to [CHANGELOG-
 
 ### Added
 
-- [Colang 2.0 Documentation](https://docs.nvidia.com/nemo/guardrails/colang_2/overview.html).
+- [Colang 2.0 Documentation](https://docs.nvidia.com/nemo/guardrails/colang-2/overview.html).
 - Revamped [NeMo Guardrails Documentation](https://docs.nvidia.com/nemo-guardrails).
 
 ### Fixed
@@ -360,7 +360,7 @@ Documentation:
 - Example [RAG using Pinecone](./examples/configs/rag/pinecone).
 - Support for loading a configuration from dictionary, i.e. `RailsConfig.from_content(config=...)`.
 - Guidance on [LLM support](./docs/user_guides/llm-support.md).
-- Support for `LLMRails.explain()` (see the [Getting Started](./docs/getting_started) guide for sample usage).
+- Support for `LLMRails.explain()` (see the [Getting Started](./docs/getting-started) guide for sample usage).
 
 ### Changed
 
@@ -369,7 +369,7 @@ Documentation:
 - Allow using actions which are not `async` functions.
 - Disabled pretty exceptions in CLI.
 - Upgraded dependencies.
-- Updated the [Getting Started Guide](./docs/getting_started).
+- Updated the [Getting Started Guide](./docs/getting-started).
 - Main [README](./README.md) now provides more details.
 - Merged original examples into a single [ABC Bot](./examples/bots/abc) and removed the original ones.
 - Documentation improvements.

README.md

@@ -216,7 +216,7 @@ Currently two versions of Colang, 1.0 and 2.0, are supported and Colang 1.0 is t
 
 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).
+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
 

docs/index.rst

@@ -28,10 +28,10 @@ NVIDIA NeMo Guardrails
    :name: Colang 2.0
    :maxdepth: 2
 
-   colang_2/overview
-   colang_2/whats-changed
-   colang_2/getting_started/index
-   colang_2/language_reference/index
+   colang-2/overview
+   colang-2/whats-changed
+   colang-2/getting-started/index
+   colang-2/language-reference/index
 
 .. toctree::
    :caption: User Guides

nemoguardrails/rails/llm/config.py

@@ -820,7 +820,7 @@ def _parse_colang_files_recursively(
             current_file, content=flow_definitions, version=colang_version
         )
 
-        _DOCUMENTATION_LINK = "https://docs.nvidia.com/nemo/guardrails/colang_2/getting_started/dialog-rails.html"  # Replace with the actual documentation link
+        _DOCUMENTATION_LINK = "https://docs.nvidia.com/nemo/guardrails/colang-2/getting-started/dialog-rails.html"  # Replace with the actual documentation link
 
         warnings.warn(
             "Configuring input/output rails in config.yml is deprecated. "

pytest.ini

@@ -10,4 +10,4 @@ log_cli = False
 
 testpaths =
     tests
-    docs/colang_2/examples
+    docs/colang-2/examples