docs(run-rails): updates for clarity and correctness

[Pouyanpi]

No description provided.

[github-actions]

Documentation preview

https://nvidia-nemo.github.io/Guardrails/review/pr-1560

[greptile-apps]

Greptile Summary

This PR improves the clarity and correctness of the run-rails documentation through several targeted enhancements. The changes focus on removing outdated information (deprecated streaming parameter, version requirements), adding helpful examples (context variable usage in Colang and Python), correcting examples to match actual usage patterns (user_message instead of score), and reorganizing content for better user flow (prioritizing "Disabling Rails" section). A deprecation warning for StreamingHandler guides users toward the preferred stream_async() method.

Key improvements:

• Removed streaming parameter from RailsConfig properties table (line 134 in core-classes.md)
• Added comprehensive context variable usage examples with Colang and Python syntax (lines 225-241 in core-classes.md)
• Corrected output_vars example from ["score"] to ["user_message"] for consistency
• Reordered generation-options.md sections to present "Disabling Rails" before "Output Variables"
• Added deprecation warning for StreamingHandler in streaming.md (line 79)
• Removed outdated LangChain version requirements section from streaming.md
• Enhanced emphasis on output rails with bold formatting

Confidence Score: 5/5

• This PR is completely safe to merge with no risk
• This is a documentation-only PR that makes purely editorial improvements. All changes enhance clarity, remove outdated information, and add helpful examples. There are no code changes, no breaking changes, and no logical errors in the documentation updates.
• No files require special attention

Important Files Changed

Filename	Overview
docs/run-rails/core-classes.md	Added context variable usage documentation and corrected example variable name from "score" to "user_message"; removed deprecated streaming parameter from table
docs/run-rails/generation-options.md	Reordered sections to prioritize "Disabling Rails" over "Output Variables" for better user flow and logical organization
docs/run-rails/index.md	Simplified description for stream_async() by removing "for responsive UIs" for more general applicability
docs/run-rails/streaming.md	Added deprecation warning for StreamingHandler, emphasized output rails with bold formatting, and removed outdated version requirements section

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation
    participant User as End User
    
    Dev->>Docs: Remove deprecated `streaming` parameter from table
    Dev->>Docs: Add context variable usage examples
    Dev->>Docs: Correct example variable name (score → user_message)
    Dev->>Docs: Reorder sections (Disabling Rails before Output Variables)
    Dev->>Docs: Add StreamingHandler deprecation warning
    Dev->>Docs: Remove outdated version requirements
    Dev->>Docs: Emphasize output rails with bold formatting
    Dev->>Docs: Simplify stream_async() description
    
    User->>Docs: Read updated documentation
    Docs-->>User: Clearer, more accurate information
    Docs-->>User: Better logical flow
    Docs-->>User: Current best practices

Loading

[greptile-apps]

Greptile's behavior is changing!

From now on, if a review finishes with no comments, we will not post an additional "statistics" comment to confirm that our review found nothing to comment on. However, you can confirm that we reviewed your changes in the status check section.

_{This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR".}

[miyoungc]

Approving. Please accept the suggestions if they look good @Pouyanpi .

[miyoungc]

Applied my suggestions to merge the PR. If any of my suggestions need changes, let's cut another PR. Wanted to merge this cause I'm gonna run another iteration on this section as well. thank you!