chore: move jail stream readme

[ayushag-nv]

Overview:

Move jail stream readme from top level to docs

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

• closes GitHub issue: #xxx

Summary by CodeRabbit

• Documentation
  • Added an initial guide covering the JailedStream implementation, featuring an Overview section to help users understand its purpose, capabilities, and high-level behavior.
  • Included a standard SPDX/Apache-2.0 license header at the top of the document for clarity and compliance.
  • Improved readability and structure with clear headings and introductory context for easier onboarding.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

Walkthrough

Added an SPDX/Apache-2.0 license header and initial documentation content (Overview) for the JailedStream Implementation in a single guide file.

Changes

Cohort / File(s)	Summary of Changes
Docs docs/guides/jail_stream_readme.md	Inserted SPDX/Apache-2.0 license header and added initial JailedStream Implementation documentation with an Overview section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibble notes in docs so fine,
A license nib stitched top-of-line.
Jailed streams now have their say,
An overview to light the way.
With twitching ears I stamp “all set”—
Approvals hop in, no regrets! 🐇📜

Pre-merge checks

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description follows the repository’s template but leaves the Details and Where should the reviewer start? sections with placeholder comments, so it does not fully communicate what was changed or where to focus the review.	Please update the Details section with a clear summary of all modifications made in this PR and populate the “Where should the reviewer start?” section with specific file paths or code areas to guide the review.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly and accurately describes the primary change, which is relocating the jail stream README into the docs folder, and it follows the conventional “chore:” prefix without adding unnecessary detail.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b5bab7 and 95ecda2.

📒 Files selected for processing (1)

• docs/guides/jail_stream_readme.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Test - dynamo

🔇 Additional comments (1)

docs/guides/jail_stream_readme.md (1)

1-145: Documentation looks solid.

License block placement and the reorganized guide read cleanly—thanks for tightening this up.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[rmccorm4]

Approving just to get it out of top-level directory

For final destination, CC @athreesh @kmkelle-nv - this is more like dynamo rust developer documentation than user documentation. Where is a good bucket for these types of things for docs UX efforts?

I think the Slurm guides are similar in that they're useful to developers, but not necessarily intended for majority of end users. CC @hutm

[rmccorm4]

@ayushag-nv to fix the failing doc generation check:

#15 4.429 checking consistency... /workspace/dynamo/docs/guides/jail_stream_readme.md: WARNING: document isn't included in any toctree [toc.not_included]

I think you need to add guides/jail_stream_readme.md to hidden_toctree for now like so:

dynamo/docs/hidden_toctree.rst

Line 39 in 8388e16

guides/tool_calling.md