Skip to content

docs: refresh release 2.1 docs#241

Merged
cdgamarose-nv merged 3 commits into
NVIDIA-AI-Blueprints:release/2.1from
AjayThorve:docs/release-2.1-refresh
May 18, 2026
Merged

docs: refresh release 2.1 docs#241
cdgamarose-nv merged 3 commits into
NVIDIA-AI-Blueprints:release/2.1from
AjayThorve:docs/release-2.1-refresh

Conversation

@AjayThorve
Copy link
Copy Markdown
Collaborator

Summary

  • refresh root README and changelogs for the 2.1.0 release, including skills, sandbox execution, Agent Skill, data-source registry, API/auth, and profiling docs links
  • bump package/docs release metadata plus Compose and Helm image/chart tags to 2.1.0
  • update deployment docs and the vendored Helm subchart package used by the parent chart

Validation

  • helm template aiq deploy/helm/deployment-k8s -n ns-aiq
  • helm lint deploy/helm/helm-charts-k8s/aiq
  • helm lint deploy/helm/deployment-k8s
  • git diff --check
  • python3 -m json.tool docs/source/project.json
  • python3 -m json.tool docs/source/versions1.json
  • commit pre-commit hooks: ruff, uv-lock, YAML checks, detect-secrets, markdown link check

Not run

  • Sphinx docs build; sphinx-build is not installed in the local release worktree environment

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 14, 2026

Greptile Summary

This PR refreshes all release 2.1.0 documentation and metadata: version strings, image tags, Helm chart versions, Sphinx/project config, changelogs, and new doc-index entries for skills/sandbox and agent-skills pages are all updated consistently. All newly-linked doc pages (integration/agent-skills.md, examples/skills-sandbox/index.md, profiling/index.md) exist on disk.

  • Version bumped to 2.1.0 across pyproject.toml, docs/source/conf.py, docs/source/project.json, docs/source/versions1.json, Docker Compose defaults, Helm parent chart, and values.yaml image tags.
  • Subchart appVersion updated to 2.1.0 and aiq-0.0.4.tgz regenerated, but chart version stays at 0.0.4 — a pre-existing concern flagged in a prior review comment that remains unresolved.
  • docs/source/resources/changelog.md promotes the former "Unreleased" block to a formal v2.1.0 section, but the v2.0.0 entry present in the root CHANGELOG.md was never backfilled into the docs changelog, leaving a visible gap in the released history.

Confidence Score: 5/5

Safe to merge — all changes are documentation and metadata updates with no logic or runtime code modified.

The PR touches only docs, version strings, image tags, and Helm chart metadata. Every newly-linked doc page exists on disk, all version strings are internally consistent, and Docker/Helm artifacts have been updated to match the 2.1.0 release. The only outstanding items are a pre-existing subchart version-string mismatch (already noted in a prior review) and a missing v2.0.0 entry in the docs changelog — neither affects runtime behavior.

docs/source/resources/changelog.md is missing the v2.0.0 release entry; deploy/helm/helm-charts-k8s/aiq/Chart.yaml still carries version 0.0.4 while its packaged content reflects 2.1.0.

Important Files Changed

Filename Overview
README.md Adds five new feature bullets for 2.1 (skills/sandbox, agent skill, data-source registry, API/auth, profiling), updates roadmap completion status, and clarifies the sandbox security note
deploy/compose/docker-compose.yaml Bumps default backend and frontend image tags from 2.0.0 to 2.1.0
deploy/helm/deployment-k8s/Chart.yaml Bumps parent chart version to 2.1.0 and fixes appVersion from '1.0' to '2.1.0'; subchart dependency still pinned to aiq 0.0.4
deploy/helm/helm-charts-k8s/aiq/Chart.yaml Updates appVersion from 2.0.0 to 2.1.0 but leaves chart version at 0.0.4, while the packaged aiq-0.0.4.tgz was regenerated with the new content — version string mismatch flagged in a prior review comment
docs/source/resources/changelog.md Replaces the "Unreleased v2.0.1" section with a formal v2.1.0 release entry; the v2.0.0 release entry present in root CHANGELOG.md is absent here, leaving a jump from v1.1.0 to v2.1.0 in the docs changelog
docs/source/conf.py Updates Sphinx release metadata from 1.2.1 to 2.1.0
pyproject.toml Bumps aiq-agent package version from 2.0.0 to 2.1.0
docs/source/index.md Adds two new navigation entries pointing to skills-sandbox and agent-skills docs pages, both of which exist on disk

Reviews (5): Last reviewed commit: "update arch diagram" | Re-trigger Greptile

Comment thread docs/source/resources/changelog.md Outdated
@AjayThorve AjayThorve force-pushed the docs/release-2.1-refresh branch from ab897ef to 770974f Compare May 14, 2026 22:27
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
@AjayThorve AjayThorve force-pushed the docs/release-2.1-refresh branch from 770974f to 15cbec3 Compare May 14, 2026 22:37
Copy link
Copy Markdown

@lvojtku lvojtku left a comment

Choose a reason for hiding this comment

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

Added comments and approved.

Comment thread docs/source/resources/changelog.md Outdated
Comment thread docs/source/resources/changelog.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@cdgamarose-nv cdgamarose-nv self-requested a review May 18, 2026 20:45
@cdgamarose-nv cdgamarose-nv merged commit 917271c into NVIDIA-AI-Blueprints:release/2.1 May 18, 2026
4 checks passed
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.

3 participants