Skip to content

docs(agents): fix broken Rust bullet and stale crate list - #527

Open
hyeonggyu wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
hyeonggyu:fix/docs-agents-typos
Open

docs(agents): fix broken Rust bullet and stale crate list#527
hyeonggyu wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
hyeonggyu:fix/docs-agents-typos

Conversation

@hyeonggyu

@hyeonggyu hyeonggyu commented Aug 22, 2026

Copy link
Copy Markdown

Summary

  • Fix a broken/orphaned sentence in AGENTS.md: the Rust style bullet had a dangling second line ("return typed errors, or match explicitly…") with no subject. Merged it into the preceding sentence and corrected .except().expect().
  • Update the Project Structure block to list the switchyard-skill-distillation and switchyard-soak crates that exist in the workspace but were missing from the diagram.

Verification

  • git diff shows 4 insertions, 2 deletions in AGENTS.md only.
  • Cross-checked crate list against origin/main Cargo.toml workspace members and the actual crates/ tree.

Test plan

  • Confirmed no other doc/code mismatches on origin/main (spell-check + manual read-through of all 44 markdown docs).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added guidance for two new project capabilities.
    • Clarified Rust error-handling conventions, including appropriate use of .expect() and error propagation with ?.
    • Specified that panicking calls are permitted only in tests.

Merge the orphaned Rust-style fragment into its sentence and update
the Project Structure block to list the switchyard-skill-distillation
and switchyard-soak crates that exist in the workspace.

Signed-off-by: Hyeonggyu Kim <hyeonggyu@live.com>
@hyeonggyu
hyeonggyu requested a review from a team as a code owner August 22, 2026 15:31
@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2b9b011f-c00e-4f7f-8e95-9b1e7ea1a44d

📥 Commits

Reviewing files that changed from the base of the PR and between 053a61e and cdec9e2.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: Your plan provides up to 12 included reviews per hour; 9 remain after this review.


Walkthrough

AGENTS.md now lists two additional crate directories and clarifies Rust panic-handling guidance.

Changes

Project Guidance Updates

Layer / File(s) Summary
Project structure and Rust guidance
AGENTS.md
The project structure includes switchyard-skill-distillation and switchyard-soak. The Rust guidance uses .expect() and requires typed error propagation with ? in production code.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to cdec9

This localized documentation update corrects Rust guidance and adds two existing crates to the project structure; no actionable merge-blocking risk remains beyond normal checks and review.

Poem

I’m a rabbit with a tidy plan,
Two new crates join the clan.
.expect() now spells the rule,
? carries errors through the school.
Hop, hop—clear docs for all!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation fixes and crate list update in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant