docs: Edits for template alignment #85
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,66 @@ | ||
| --- | ||
| title: "Release Notes for NVIDIA NeMo Fabric" | ||
| sidebar-title: "Release Notes" | ||
| description: "New features, fixed issues, and known issues for each NVIDIA NeMo Fabric release." | ||
| template-library-version: "1.0.0" | ||
| --- | ||
| {/* SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 */} | ||
|
|
||
| This documentation contains the release notes for [NVIDIA NeMo Fabric](/about-ne-mo-fabric/overview). | ||
|
There was a problem hiding this comment. 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Description: Verify the slug for the overview page in Fern configuration.
# Check docs.yml or index.yml for the overview page slug
rg -n 'about-ne-mo-fabric\|about-nemo-fabric' docs/index.yml docs/docs.yml 2>/dev/null || echo "No index/docs config found, check manually"
# Also verify the overview file exists
fd -i 'overview.mdx' docs/Repository: NVIDIA/NeMo-Fabric Length of output: 235 🏁 Script executed: #!/bin/bash
set -euo pipefail
echo "== files of interest =="
git ls-files 'docs/**' 'README.md' | rg 'about-nemo-fabric|index\.yml|docs\.yml|fern|config|overview\.mdx|release-notes\.mdx'
echo
echo "== search for slug metadata =="
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/.git/**' \
'about-ne-mo-fabric|about-nemo-fabric|slug:|permalink:|route:|path:' \
docs README.md . 2>/dev/null || true
echo
echo "== overview frontmatter =="
sed -n '1,80p' docs/about-nemo-fabric/overview.mdx
echo
echo "== release notes header =="
sed -n '1,60p' docs/about-nemo-fabric/release-notes.mdxRepository: NVIDIA/NeMo-Fabric Length of output: 50375 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '== relevant files ==\n'
git ls-files 'docs/about-nemo-fabric/*' 'docs/**/*' | rg 'about-nemo-fabric|fern|index\.yml|docs\.yml'
printf '\n== slug references ==\n'
rg -n --hidden --glob 'docs/**' --glob '!**/node_modules/**' \
'about-ne-mo-fabric|about-nemo-fabric|slug:|permalink:|route:|path:' \
docs 2>/dev/null | head -n 200
printf '\n== overview.mdx head ==\n'
sed -n '1,40p' docs/about-nemo-fabric/overview.mdx
printf '\n== release-notes.mdx head ==\n'
sed -n '1,30p' docs/about-nemo-fabric/release-notes.mdxRepository: NVIDIA/NeMo-Fabric Length of output: 26192 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '== fern / docs config files ==\n'
git ls-files | rg '(^|/)(fern.*|.*fern.*|docs\.yml|index\.yml|config\.yml|config\.yaml|site\.yml|site\.yaml)$'
printf '\n== slug / alias references in config files ==\n'
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/.git/**' \
'about-ne-mo-fabric|about-nemo-fabric|slug:|alias:|aliases:|redirect|canonical' \
. 2>/dev/null | head -n 200
printf '\n== root docs-related config heads ==\n'
for f in $(git ls-files | rg '(^|/)(fern.*|.*fern.*|docs\.yml|index\.yml|config\.yml|config\.yaml|site\.yml|site\.yaml)$'); do
printf '\n--- %s ---\n' "$f"
sed -n '1,80p' "$f"
doneRepository: NVIDIA/NeMo-Fabric Length of output: 50375 Fix the overview link slug. 🤖 Prompt for AI AgentsSource: Path instructions |
||
|
|
||
| ## Release `<Number.Number.Number>` | ||
|
|
||
| {/* Provide the release summary here. Replace the following paragraph with your own. */} | ||
| This release `<focus / soul / spirit of the release>`... | ||
|
|
||
| ### Highlights | ||
|
|
||
| This release contains the following key changes: | ||
|
|
||
| - Item 1. For details, refer to [Link to documentation](doc.mdx). | ||
| - Item 2. For details, refer to [Link to documentation](doc.mdx). | ||
| - Item 3. For details, refer to [Link to documentation](doc.mdx). | ||
|
|
||
| {/* Optional: include this section if you have support matrix or compatibility updates for this release. */} | ||
| ### Support Matrix and Compatibility Updates | ||
|
|
||
| This release includes the following support matrix and compatibility updates: | ||
|
|
||
| - Added support for `<platform>`. For details, refer to [Support Matrix](support-matrix.mdx). | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| ### Fixed Known Issues | ||
|
|
||
| This version fixes the following known issues: | ||
|
|
||
| - Fixed known issue 1. For details, refer to [Link to documentation](doc.mdx) or [Link to troubleshooting](troubleshooting.mdx). | ||
| - Fixed known issue 2. For details, refer to [Link to documentation](doc.mdx) or [Link to troubleshooting](troubleshooting.mdx). | ||
| - Fixed known issue 3. For details, refer to [Link to documentation](doc.mdx) or [Link to troubleshooting](troubleshooting.mdx). | ||
|
|
||
| For the full list of known issues, refer to [Known Issues](#all-known-issues). | ||
|
|
||
| ## All Known Issues | ||
|
|
||
| {/* Provide the known issues list here. Replace the following information with your own, or state that there are no known issues in this release. */} | ||
| The known issues for NVIDIA NeMo Fabric are the following: | ||
|
|
||
| - (New in version N.N.0) Known issue 1. [Link to documentation](doc.mdx) or [Link to troubleshooting](troubleshooting.mdx). | ||
| - (New in version N.N.0) Known issue 2. [Link to documentation](doc.mdx) or [Link to troubleshooting](troubleshooting.mdx). | ||
| - Known issue 3. [Link to documentation](doc.mdx) or [Link to troubleshooting](troubleshooting.mdx). | ||
|
|
||
| {/* Optional: include this section if you want to link directly to previous versions of the release notes. */} | ||
| ## Release Notes for Previous Versions | ||
|
|
||
| Find the release notes for previous versions at the following links: | ||
|
|
||
| - [N.N.N](link.mdx) | ||
| - [N.N.N](link.mdx) | ||
| - [N.N.N](link.mdx) | ||
|
|
||
| ## Related Topics | ||
|
|
||
| {/* Provide a list of links to related topics. Include correct page titles and file names for the links. */} | ||
| For more information, refer to the following related topics: | ||
|
|
||
| - [related-topic-1](link.mdx) | ||
| - [related-topic-2](link.mdx) | ||
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
|
Collaborator
There was a problem hiding this comment. Not sure where this document came from, we don't need a quickstart and a quick-start |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| title: "NVIDIA NeMo Fabric Quickstart" | ||
| sidebar-title: "Quickstart" | ||
| description: "Install NeMo Fabric from a source checkout and run a simple agent through the Python SDK." | ||
| --- | ||
| {/* SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 */} | ||
|
|
||
| Install `just` 1.50.0+ if it is not already available. | ||
|
|
||
| ```bash | ||
| cargo install just --locked | ||
| ``` | ||
|
|
||
| Refer to the [official installation guide](https://just.systems/man/en/installation.html) | ||
| for more details. | ||
|
|
||
| Ensure that the Cargo bin directory is in your `PATH`: | ||
|
|
||
| ```bash | ||
| export PATH="$HOME/.cargo/bin:$PATH" | ||
| ``` | ||
|
|
||
| Create a Python virtual environment and activate it (replace `3.13` with your preferred Python version): | ||
|
|
||
| ```bash | ||
| uv venv -p 3.13 --seed .venv | ||
| source .venv/bin/activate | ||
| ``` | ||
|
|
||
| Install the Python SDK with its native binding and the CLI from a source | ||
| checkout: | ||
|
|
||
| ```bash | ||
| just build-all | ||
|
Comment on lines
+9
to
+35
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Should Fix — Document Required Setup Tools Line 9 invokes 🤖 Prompt for AI AgentsSources: Coding guidelines, Path instructions |
||
| ``` | ||
|
|
||
| Run the example through the Python SDK: | ||
|
|
||
| ```python | ||
| import asyncio | ||
| from examples.code_review_agent import BASE_DIR, hermes_config | ||
| from nemo_fabric import Fabric | ||
|
|
||
|
|
||
| async def main() -> None: | ||
| config = hermes_config() | ||
| client = Fabric() | ||
| result = await client.run( | ||
| config, | ||
| base_dir=BASE_DIR, | ||
| input="Reply with exactly: fabric works", | ||
| ) | ||
|
|
||
| print(result.status) | ||
|
|
||
|
|
||
| asyncio.run(main()) | ||
| ``` | ||
|
|
||
| Harness installation and credential requirements differ by adapter. The | ||
| [repository quick start](https://github.com/NVIDIA/NeMo-Fabric#quick-start-hermes) | ||
| contains the complete Hermes environment recipe. | ||
|
|
||
| Refer to the [Python SDK guide](/sdk/python) for planning, diagnostics, typed | ||
| requests, and multi-turn runtime examples. | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.