docs: add parallel rail section + split config page

[miyoungc]

Description

1. Split the huge config page into multiple sections.
2. Run edit on the rails config page (preview).
3. Add parallel rail section.

https://docs.google.com/document/d/1xV0uSvv2G5iYLK4nz0e0T7VL--bTf0hKlQnhePRJqB0/edit?tab=t.0

Related Issue(s)

none

Checklist

• I've read the CONTRIBUTING guidelines.
• I've updated the documentation if applicable.
• I've added tests if applicable.
• @mentions of the person or team responsible for reviewing proposed changes.

[github-actions]

Documentation preview

https://nvidia.github.io/NeMo-Guardrails/review/pr-1295

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.45%. Comparing base (8575b88) to head (56e32a0).
⚠️ Report is 6 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1295      +/-   ##
===========================================
+ Coverage    70.13%   70.45%   +0.31%     
===========================================
  Files          161      161              
  Lines        16037    16214     +177     
===========================================
+ Hits         11248    11423     +175     
- Misses        4789     4791       +2     

Flag	Coverage Δ
python	70.45% <ø> (+0.31%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 7 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Pouyanpi]

thank you @miyoungc 👍🏻 , I did a quick iteration and I like the new structure. I'll do another in depth round soon.

[tgasser-nv]

Summary

I only reviewed the parallel rails and RAG/knowledge base sections. I'm assuming the rest is the splitting of configuration into multiple files.

The Parallel Rails section needs updating, here's some more context on the feature.

For true parallel rail calling for any configuration, we need to use Colang 2. This isn't yet integrated and tested in Guardrails. It would take ~2 months work to get Colang 2 up to feature parity with Colang 1, so we decided to point-fix Colang 1 to enable parallel rail execution.

Because this is a point-fix and will be deprecated when Colang 2 is adopted, we limited the scope to support two templates:

* https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/examples/notebooks/safeguard_ai_virtual_assistant_notebook.ipynb 
* https://developer.nvidia.com/blog/content-moderation-and-safety-checks-with-nvidia-nemo-guardrails/ 

These two templates are QA'ed and validated to work. Other configs may work, but we haven't tested them and users are encouraged to validate them themselves. Configs which mutate input data aren't guaranteed to give the same output as sequential rails, since they're executing in parallel with no dependency tracking.

[miyoungc]

I only reviewed the parallel rails and RAG/knowledge base sections. I'm assuming the rest is the splitting of configuration into multiple files.

Yes, that's correct. The parallel rails section in guardrails-configuration.md and the entire knowledge-base.md are the parts that I need your review. The rest are the same.

[miyoungc]

@tgasser-nv Added the example configurations to the same section for parallel rail, instead of creating a new tutorial page. I hope this is sufficient. Also added the note to the same section. Here's the link to the preview of the section: https://nvidia.github.io/NeMo-Guardrails/review/pr-1295/user-guides/configuration-guide/guardrails-configuration.html#parallel-execution-of-input-and-output-rails

[tgasser-nv]

Added some comments and suggestions. Main changes are to explicitly call out we validate the content-safety, topic control, and jailbreak to make sure it works. While other configurations may work, we don't validate them.

[miyoungc]

@Pouyanpi @tgasser-nv incorporated feedback from both of you. Please take a look and approve so that I can merge this now. Thanks!

[tgasser-nv]

LGTM, thanks for making the changes

[Pouyanpi]

Thank you @miyoungc 👍🏻