align extraction links with quickstart, NeMo-Retriever paths, and API docs#2048
Merged
Merged
Conversation
Point notebook tips at the self-hosted quickstart anchors, refresh NeMo-Retriever Helm and compose URLs for air-gapped and quickstart flows, fix the raw GitHub helm README target, and tidy link targets across the extraction doc set.
Contributor
Greptile SummaryThis documentation-only PR updates cross-reference links across 11 extraction docs to align with the 26.03 self-hosted story: in-tree quickstart anchors replace scattered external notebook URLs, and NeMo-Retriever external links are pinned to the
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/quickstart-guide.md | Helm chart link updated to NeMo-Retriever 26.03 branch; docker-compose link in air-gap section pinned to 26.03; self-referential tips removed; MIG section still uses a raw.githubusercontent link with the text raw.githubusercontent as the anchor. |
| docs/docs/extraction/air-gapped-deployment.md | All three external links updated from release/26.3.0 to 26.03 branch; note text reworded to remove the main moves forward contradiction. |
| docs/docs/extraction/notebooks.md | CLI and Python notebook links replaced with in-tree quickstart anchors; prose updated to reflect guides and notebooks. |
| docs/docs/extraction/support-matrix.md | nemotron-parse link updated from docs.nvidia.com NIM example page to docs.api.nvidia.com API reference. |
| docs/docs/extraction/user-defined-functions.md | UDF examples link changed from pinned nv-ingest release/26.1.2 to NeMo-Retriever main branch, which is a moving target. |
| docs/docs/extraction/audio.md | Two Python tip links switched from external nv-ingest notebook URL to local quickstart-guide.md anchor. |
| docs/docs/extraction/cli-reference.md | Tip now points at the 26.03-branch companion notebook and the in-tree CLI quickstart anchor. |
| docs/docs/extraction/nemoretriever-parse.md | Two Python tip links updated to in-tree quickstart anchor, matching changes in audio.md. |
| docs/docs/extraction/nv-ingest-python-api.md | Tip updated to reference quickstart Python anchor and Python API reference page instead of the external notebook URL. |
| docs/docs/extraction/nv-ingest_cli.md | Tip updated to reference in-tree quickstart CLI anchor and CLI reference page instead of the external notebook URL. |
| docs/docs/extraction/python-api-reference.md | Tip now links to in-tree quickstart Python anchor and the Python API page, replacing the previous external notebook URL. |
| CONTRIBUTING.md | Missing newline added at end of file. |
| docs/docs/extraction/releasenotes-nv-ingest.md | Missing newline added at end of file. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Extraction docs tip / link] -->|old| B[External nv-ingest GitHub notebook URL]
A -->|new| C[In-tree quickstart-guide.md anchor]
C --> D["#ingest_python_example"]
C --> E["#ingest_cli_example"]
F[NeMo-Retriever external link] -->|old: release/26.3.0 or main| G[Legacy / moving ref]
F -->|new| H[26.03 branch pin]
H --> I[docker-compose.yaml]
H --> J[helm/README.md]
H --> K[helm/values.yaml]
H --> L[cli_client_usage.ipynb]
M[support-matrix.md] -->|nemotron-parse| N[docs.api.nvidia.com API reference]
O[user-defined-functions.md] -->|UDF examples| P[NeMo-Retriever main branch]
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 2
docs/docs/extraction/user-defined-functions.md:943
**Moving-target link for versioned docs**
The "Related Topics" link was changed from the pinned `nv-ingest/release/26.1.2` ref to `NeMo-Retriever/main`, which advances continuously. If the UDF API or README changes between now and the next time a user reads the 26.03 docs, they'll follow a link to content that no longer matches what's described on the page. Consider pinning to `26.03` (matching the branch this PR targets) or to the equivalent `release/26.03` tag if one exists in NeMo-Retriever.
### Issue 2 of 2
docs/docs/extraction/quickstart-guide.md:531
**Meaningless anchor text on MIG section link**
The rendered link text `raw.githubusercontent` gives readers no context about the destination. Consider replacing it with a descriptive label such as `Helm README` so it reads "…expose the desired MIG profiles (see [Helm README](https://raw.githubusercontent.com/NVIDIA/NeMo-Retriever/26.03/helm/README.md))."
Reviews (4): Last reviewed commit: "chore: add missing EOF newlines for pre-..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
… pins Drop third-party notebook and fork URLs, pin NeMo Retriever air-gap and quickstart references to the 26.03 branch (including helm paths on that branch), point the CLI tip at the 26.03 companion notebook plus the quickstart anchor, and remove redundant same-page tips in the quickstart.
Fix end-of-file-fixer failures in CONTRIBUTING.md and releasenotes-nv-ingest.md so CI pre-commit --all-files passes.
randerzander
requested changes
May 18, 2026
| ## Related Topics | ||
|
|
||
| - [NV-Ingest UDF Examples](https://github.com/NVIDIA/nv-ingest/blob/release/26.1.2/examples/udfs/README.md) | ||
| - [NV-Ingest UDF Examples](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/udfs/README.md) |
Collaborator
There was a problem hiding this comment.
remove nv-ingest references
| @@ -536,4 +536,4 @@ Portions adopted from | |||
|
|
|||
| - [https://github.com/nv-morpheus/Morpheus/blob/branch-24.06/CONTRIBUTING.md](https://github.com/nv-morpheus/Morpheus/blob/branch-24.06/CONTRIBUTING.md) | |||
Collaborator
There was a problem hiding this comment.
remove morpheus references
| @@ -319,10 +315,6 @@ image_caption:[] | |||
|
|
|||
| ### Using the `nv-ingest-cli` | |||
Collaborator
There was a problem hiding this comment.
remove nv-ingest references
| !!! tip | ||
|
|
||
| There is a Jupyter notebook available to help you get started with the CLI. For more information, refer to [CLI Client Quick Start Guide](https://github.com/NVIDIA/NeMo-Retriever/blob/main/client/client_examples/examples/cli_client_usage.ipynb). | ||
| For CLI examples, see the [CLI section of the self-hosted quickstart](quickstart-guide.md#ingest_cli_example) or the [CLI companion notebook on the `26.03` branch](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/client/client_examples/examples/cli_client_usage.ipynb). |
Collaborator
There was a problem hiding this comment.
Why is this hardlinking a release branch?
| For more Python examples, refer to the [Python Client Quick Start Guide](quickstart-guide.md#ingest_python_example). | ||
|
|
||
|
|
||
| ## Use NVCF Endpoints for Cloud-Based Inference |
Collaborator
There was a problem hiding this comment.
NVCF== build.nvidia.com
| ## Helm charts and packaging artifacts | ||
|
|
||
| From a connected environment, download and version-control the chart archive you install, for example (see [NV-Ingest Helm README](https://github.com/NVIDIA/NeMo-Retriever/blob/release/26.3.0/helm/README.md)): | ||
| From a connected environment, download and version-control the chart archive you install, for example (see [NV-Ingest Helm README](https://github.com/NVIDIA/NeMo-Retriever/blob/26.03/helm/README.md)): |
Collaborator
There was a problem hiding this comment.
remove nv-ingest references
sosahi
approved these changes
May 18, 2026
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
3 participants
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.
Summary
Documentation-only PR for NVBug 6179241 (extraction docs link fix, batch 1). Branch
kheiss/6179241-batch1is based on26.03with 4 commits; 13 files changed (+24 / −32 lines).Link and navigation updates (11 extraction docs)
quickstart-guide.md#ingest_python_exampleand#ingest_cli_examplewhere appropriate (audio.md,nemoretriever-parse.md,notebooks.md,nv-ingest-python-api.md,nv-ingest_cli.md, and related pages).AI-AppGitHub fork); restoredgithub.com/NVIDIA/nv-ingestforimage_viewer.py.NVIDIA/NeMo-Retriever26.03for compose/Helm (helm/on that branch), including the raw GitHub Helm README used in the MIG section.26.03CLI companion notebook onNVIDIA/NeMo-Retriever(notrelease/25.3.0).docs.api.nvidia.com.NVIDIA/NeMo-Retrievermainexamples/udfs/README.md.Review-driven cleanups
quickstart-guide.md— Removed self-referential!!! tipblocks that only linked to anchors on the same page; stripped accidental UTF-8 BOM so the H1 renders correctly in MkDocs.python-api-reference.md— Tip aligned withnv-ingest-python-api.md(in-tree quickstart + API page cross-link).CI / pre-commit
CONTRIBUTING.mdandreleasenotes-nv-ingest.md— Added missing EOF newlines sopre-commit run --all-filespasses (end-of-file-fixer).Base:
26.03· Commits:50fc8073,dde2c19d,5f42a3fe,4697db31Files changed
air-gapped-deployment.md,quickstart-guide.mdnv-ingest-python-api.md,nv-ingest_cli.md,python-api-reference.md,cli-reference.mdaudio.md,nemoretriever-parse.md,notebooks.md,support-matrix.md,user-defined-functions.mdCONTRIBUTING.md,releasenotes-nv-ingest.mdTest plan
--all-files) passes on the PR.mkdocs build(or docs CI) succeeds with no warnings for touched pages.notebooks.md,cli-reference.md, andpython-api-reference.mdto quickstart anchors.NVIDIA/NeMo-Retriever26.03open in the browser (compose,helm/values.yaml,helm/README.md).quickstart-guide.mdhas no BOM (first byte is#, notEF BB BF).image_viewer.pyand nemotron-parse URLs resolve to official NVIDIA destinations.