Skip to content

Kheiss/qa review2#1583

Merged
jdye64 merged 15 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/qa-review2
Mar 11, 2026
Merged

Kheiss/qa review2#1583
jdye64 merged 15 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/qa-review2

Conversation

@kheiss-uwzoo
Copy link
Collaborator

Branch: kheiss/qa-review2
Purpose: Address open documentation bugs: prerequisite and URL corrections, Support Matrix and VLM link fixes, and MkDocs build/link fixes.


Summary

This PR addresses documentation bugs in the extraction docs and MkDocs setup:

  1. “Addressing open documentation bugs” (commit 317e7cf) — Prerequisites (Python 3.12+), Support Matrix URL and embedding model name, quickstart venv/MIG link fixes, VLM overview link.
  2. MkDocs build and link fixes — Remove invalid nav entry, fix broken links and anchors so mkdocs build completes cleanly.

1. Addressing open documentation bugs (commit 317e7cf)

  • docs/docs/extraction/audio.md — Corrected RIVA Support Matrix URL to support-matrix/support-matrix.html.
  • docs/docs/extraction/prerequisites.md — Added Python 3.12+ to software requirements; clarified note that Python must be installed before creating the environment and that 3.10/3.11 cause dependency resolution failures.
  • docs/docs/extraction/quickstart-guide.md — Added Python 3.12+ requirement before venv commands; updated tip from Conda to virtual environment; fixed MIG raw.githubusercontent link (removed errant character).
  • docs/docs/extraction/support-matrix.md — Added “Software Requirements” section with Python 3.12+; updated embedding model name from llama3.2-nv-embedqa-1b-v2 to llama-nemotron-embed-1b-v2.
  • docs/docs/extraction/vlm-embed.md — Fixed NeMo Retriever Library link from external search URL to overview.md.

2. MkDocs build and link fixes

  • Navigation (docs/mkdocs.yml): Removed invalid nav entry API Reference: extraction/api-docs (path does not exist).
    Optional (Bug 5966354): If merging nav fixes for CLI/API reference pages, ensure “Use the CLI” → extraction/cli-reference.md and “Use the API” → extraction/python-api-reference.md, with redirects from nv-ingest_cli.md and nv-ingest-python-api.md (may already be present in your working tree).
  • Links: In user-defined-functions.md, replaced broken relative link to config/default_pipeline.yaml with a GitHub URL. In content-metadata.md, added explicit fragment IDs for in-page anchors (#nearbyobjectsschema, #errormetadataschema, #infomessagemetadataschema).
  • Result: mkdocs build -f docs/mkdocs.yml completes without the reported nav/link warnings.

Files changed

Area Files
Docs (extraction) audio.md, prerequisites.md, quickstart-guide.md, support-matrix.md, vlm-embed.md
Docs (config) mkdocs.yml (nav/redirects as noted above)

@kheiss-uwzoo kheiss-uwzoo requested a review from a team as a code owner March 11, 2026 20:07
@jdye64 jdye64 merged commit ab2d503 into NVIDIA:main Mar 11, 2026
7 of 9 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.

2 participants