Skip to content

docs: update 0.3 release notes - #787

Merged
mckornfield merged 1 commit into
mainfrom
6480083-version-docs/mkornfield
Jul 20, 2026
Merged

docs: update 0.3 release notes#787
mckornfield merged 1 commit into
mainfrom
6480083-version-docs/mkornfield

Conversation

@mckornfield

@mckornfield mckornfield commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added release notes for version 0.2.0 and updated release navigation links.
    • Updated v0.3.0 documentation to cover self-managed Kubernetes/Helm, revised compatibility and upgrade guidance, and refreshed current constraints.
    • Added Kubernetes requirements with a component-by-component checklist.
    • Updated plugin and Customizer docs to align with the current release (including release-matched container image tags and clearer local setup expectations).
    • Improved generated configuration reference formatting and clarified supported vs. out-of-scope deployment options.

@mckornfield
mckornfield requested review from a team as code owners July 20, 2026 16:17
@github-actions github-actions Bot added the docs label Jul 20, 2026
@coderabbitai

coderabbitai Bot commented Jul 20, 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: 5e7e12fc-b345-4432-bdc8-024dc606d754

📥 Commits

Reviewing files that changed from the base of the PR and between bdf00a6 and ab66d2f.

📒 Files selected for processing (14)
  • docs/about/release-notes/current-release.mdx
  • docs/about/release-notes/index.mdx
  • docs/about/release-notes/release-0-2-0.mdx
  • docs/agents/plugins.mdx
  • docs/customizer/index.mdx
  • docs/customizer/tutorials/sft-customization-job.ipynb
  • docs/customizer/tutorials/sft-customization-job.mdx
  • docs/fern/components/notebooks/sft-customization-job.json
  • docs/fern/components/notebooks/sft-customization-job.ts
  • docs/fern/versions/latest.yml
  • docs/requirements.mdx
  • docs/set-up/config-reference.mdx
  • docs/support-matrix.mdx
  • script/generate_config_docs.py
💤 Files with no reviewable changes (4)
  • docs/customizer/tutorials/sft-customization-job.mdx
  • docs/customizer/tutorials/sft-customization-job.ipynb
  • script/generate_config_docs.py
  • docs/set-up/config-reference.mdx
🚧 Files skipped from review as they are similar to previous changes (6)
  • docs/about/release-notes/index.mdx
  • docs/fern/versions/latest.yml
  • docs/customizer/index.mdx
  • docs/agents/plugins.mdx
  • docs/about/release-notes/release-0-2-0.mdx
  • docs/about/release-notes/current-release.mdx

📝 Walkthrough

Walkthrough

Updates NeMo Platform documentation for v0.3.0, adds archived v0.2.0 release notes, documents self-managed Kubernetes requirements, generalizes plugin and image-tag guidance, removes obsolete tutorial anchors, and changes generated configuration references to use MDX front matter.

Changes

Release documentation

Layer / File(s) Summary
Release notes and navigation
docs/about/release-notes/*, docs/fern/versions/latest.yml
Updates v0.3.0 notes, adds v0.2.0 notes, and exposes both releases in navigation.
Deployment requirements and compatibility
docs/requirements.mdx, docs/support-matrix.mdx
Documents local-install and self-managed Kubernetes requirements while revising v0.3.0 support scope.
Plugin and Customizer guidance
docs/agents/plugins.mdx, docs/customizer/index.mdx
Generalizes local OSS plugin requirements and replaces fixed Customizer image tags with release placeholders.
Generated references and tutorial anchors
script/generate_config_docs.py, docs/set-up/config-reference.mdx, docs/customizer/tutorials/*, docs/fern/components/notebooks/*
Generates MDX front matter and removes obsolete deployment-section anchors from tutorial source and generated representations.

Suggested reviewers: ironcommit, tylersbray

🚥 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 accurately summarizes the main change: updating the documentation for the 0.3 release notes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 6480083-version-docs/mkornfield

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/requirements.mdx`:
- Line 26: Update the Kubernetes permission requirements to reference
“persistent volume claims (PVCs)” instead of “persistent volumes” in
docs/requirements.mdx lines 26-26 and docs/support-matrix.mdx lines 19-19.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f3d6d057-32cf-46e8-b1f1-2886d1ac7697

📥 Commits

Reviewing files that changed from the base of the PR and between 321736d and bdf00a6.

📒 Files selected for processing (10)
  • docs/about/release-notes/current-release.mdx
  • docs/about/release-notes/index.mdx
  • docs/about/release-notes/release-0-2-0.mdx
  • docs/agents/plugins.mdx
  • docs/customizer/index.mdx
  • docs/fern/versions/latest.yml
  • docs/requirements.mdx
  • docs/set-up/config-reference.mdx
  • docs/support-matrix.mdx
  • script/generate_config_docs.py
💤 Files with no reviewable changes (2)
  • docs/set-up/config-reference.mdx
  • script/generate_config_docs.py

Comment thread docs/requirements.mdx
@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 26382/34030 77.5% 61.8%
Integration Tests 15171/32655 46.5% 18.7%

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
@mckornfield
mckornfield force-pushed the 6480083-version-docs/mkornfield branch from bdf00a6 to ab66d2f Compare July 20, 2026 16:45
@mckornfield
mckornfield added this pull request to the merge queue Jul 20, 2026
Merged via the queue into main with commit 0f2a028 Jul 20, 2026
61 checks passed
@mckornfield
mckornfield deleted the 6480083-version-docs/mkornfield branch July 20, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants