Skip to content

Comments

Kheiss/release 2.4.0 docs#358

Open
kheiss-uwzoo wants to merge 3 commits intorelease-v2.4.0from
kheiss/release-2.4.0-docs
Open

Kheiss/release 2.4.0 docs#358
kheiss-uwzoo wants to merge 3 commits intorelease-v2.4.0from
kheiss/release-2.4.0-docs

Conversation

@kheiss-uwzoo
Copy link
Collaborator

Summary

This PR backports a small set of documentation updates from the RC/develop line into release-v2.4.0:

Fixes broken and incorrect image links in the docs (e.g., docs/deploy-helm.md, docs/observability.md, docs/index.md).

Updates Helm deployment instructions to reflect the current recommended charts and values for the 2.4.0 release.

Cleans up minor formatting/wording issues in the docs so the published 2.4.0 docs match what shipped in RC3.

Implementation

Changes were cherry‑picked from the RC/docs branch (kheiss/rc3-doc-fixes) onto a new docs‑only branch based on release-v2.4.0.

Only docs/* files are touched in this PR; no changes to runtime code or tests are included.

Testing:

Built the docs locally (where applicable) and manually verified the updated pages render correctly and the links resolve.

kheiss-uwzoo and others added 3 commits February 13, 2026 08:37
Update deploy-helm.md

removed conflict markers
* Hotfix doc release v2.4.0.rc3 (#323)

* docs: fix typos, grammar, and broken links in documentation

- README: remove duplicate 'with', fix 'e.g.' punctuation, fix link spacing
- ci/README: GitLab CI -> GitHub Actions CI pipeline
- docs/support-matrix: Bluprint -> Blueprint, fix link spacing
- docs/deploy-docker-self-hosted: add 'are' before deployed, NIMS -> NIMs
- docs/troubleshooting: fix stray markdown, subsequent deployments section
- docs/release-notes: DRA -> MIG, Nvidia -> NVIDIA, fix punctuation and its/it's
- docs/python-client: add missing closing quote in install command
- docs/text_only_ingest: remove duplicate 'the'
- docs/multi-collection-retrieval: its -> it's (it is enabled)
- docs/query_decomposition: add note for 1997/Naples example
- docs/user-interface: 750 px -> 750px
- deploy/workbench: fix hardware-requirements link to support-matrix, model v1.5
- tests/integration/README: fix test_cases formatting

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix: documents words

---------

Co-authored-by: Cursor <cursoragent@cursor.com>

* Update tech diagram (#329)

* Fixing mcp server bug (#325)

Signed-off-by: Niyati Singal <nsingal@nvidia.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

* changes to docs per bug 5767861 (#328)

* Updated launchable with v2.4.0 tag (#318)

* updated support matrix (#321)

* Document the end‑to‑end flow from query to answer and show how to measure time spent in each stage of the RAG pipeline. (#317)

* adding oberservablility

* Update docs/debugging.md

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

* Update docs/observability.md

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

* Add query-to-answer-pipeline doc and observability/debugging updates

* Trigger CI

* getting build to kick in for observability file

* Fix typos in query-to-answer-pipeline.md and ensure file in PR for link check

* get rid of PULL_REQUEST_SUMMARY

---------

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

* fixed files associated with build (#322)

* Add multimodal query integration tests to CI pipeline

* changes to docs per bug 5767861

* updated files per bug 5880717 (#327)

* updated files per bug 5880717

* Update CONTRIBUTING.md

* Update README.md

* Update python-client.md

* Update readme.md

* Update readme.md

* Update docs/deploy-helm.md

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

* Update docs/deploy-helm.md

Co-authored-by: nkmcalli <nkmcalli@yahoo.com>

---------

Co-authored-by: rkharwar-nv <rkharwar@nvidia.com>
Co-authored-by: nkmcalli <nkmcalli@yahoo.com>
Co-authored-by: Pranjal Doshi <pranjald@nvidia.com>
Co-authored-by: nv-pranjald <150428320+nv-pranjald@users.noreply.github.com>

* Fix workflow rule and doc bugs (#331)

* Revert back milvus version in conf.md to v2.6.5

* Modify workflow to run on any branch

* Fix workflow push rule to run on protected branches

* Add files via upload (#326)

Found an error in the Q&A section where images in the citation were not being printed.

* Update transformers version to 5.1.0 (#332)

* Updated launchable with v2.4.0 tag (#318)

* Fix image links

---------

Signed-off-by: Niyati Singal <nsingal@nvidia.com>
Co-authored-by: Johnny J <johnnyj@nvidia.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Shubhadeep Das <149712532+shubhadeepd@users.noreply.github.com>
Co-authored-by: niyatisingal <nsingal@nvidia.com>
Co-authored-by: rkharwar-nv <rkharwar@nvidia.com>
Co-authored-by: nkmcalli <nkmcalli@yahoo.com>
Co-authored-by: Pranjal Doshi <pranjald@nvidia.com>
Co-authored-by: nv-pranjald <150428320+nv-pranjald@users.noreply.github.com>
* updated helm instructions

* Update deploy-helm.md
@kheiss-uwzoo kheiss-uwzoo added the documentation Improvements or additions to documentation label Feb 13, 2026
4. Verify that you have Kubernetes v1.34.2 installed and running on Ubuntu 22.04/24.04. For more information, see [Kubernetes documentation](https://kubernetes.io/docs/setup/) and [NVIDIA Cloud Native Stack](https://github.com/NVIDIA/cloud-native-stack).

5. Verify that you have installed Helm 3. To install Helm 3 (and avoid Helm 4), follow the official Helm v3 installation instructions for your platform, for example by using the `get-helm-3` script described in the [Helm documentation](https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3).
5. Verify that you have installed Helm 3. To install Helm 3 (and avoid Helm 4), follow the official Helm v3 installation instructions for your platform, for example by using the `get-helm-3` script described in the [Helm documentation](https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3For).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Isnt for at end of the link a typo?

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants