docs: restructure About Building Workflows to the about-procedural-task template#2058
Draft
chenopis wants to merge 1 commit into
Draft
Conversation
…sk template This page is the NVIDIA tech-docs template-library's cited example for the "Introductory About Procedural Task Topic" template, but its heading structure had diverged from that template. Reorganizes the existing content under the template's prescribed H2 sections (Workflow Overview, Key Concepts, Common Approaches, Decision Factors), adds a per-agent "Best for" note to the agent list, and adds a Router-vs-Sequential comparison table. All existing prose, links, the YAML example, and the SPDX license header are preserved verbatim. New descriptive text (the "Best for" notes and the comparison-table cells) is sourced from the corresponding agent doc pages, not invented. Signed-off-by: Andrew Chen <andrewch@nvidia.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Restructures About Building NVIDIA NeMo Agent Toolkit Workflows (
docs/source/build-workflows/about-building-workflows.md) to conform to the about-procedural-task documentation template.Why
This page is the cited example for the "Introductory About Procedural Task Topic" template in NVIDIA's tech-docs template-library, but its section structure had diverged from that template. This change (from a template-library conformance audit) realigns it.
Change
Opened as draft — this is a proposed structural alignment to the docs template. Maintainers may prefer different "Best for" phrasing, or to keep the existing structure; happy to adjust.
🤖 Generated with Claude Code