Align quickstart with uv venv, nv-ingest runtime, and safe CLI sample output

[kheiss-uwzoo]

Align quickstart with uv venv, nv-ingest runtime, and safe CLI sample output

Summary

This updates the Docker Compose quickstart so host setup, in-container Python, and example logs match current tooling and avoid misleading or internal-only details.

Changes

Host client setup (new steps i–j after docker ps)
Documents creating a Python 3.12 environment with uv, naming the venv nv-ingest-dev, and installing nv-ingest, nv-ingest-api, and nv-ingest-client (pinned to 26.1.2). Adds tips for checking activation with which pip / which python, notes on exposing the runtime port from docker-compose.yaml, and docker exec into nv-ingest-nv-ingest-ms-runtime-1 (consistent with the docker ps example in the same page).

In-container environment

Replaces incorrect Conda / nemo_retriever_runtime wording with the image’s uv-based layout: Python 3.12 at /opt/nv_ingest_runtime, matching the Dockerfile.

CLI example log (NLTK)

Replaces a leaked internal filesystem path and Python 3.10 in the sample nltk_data output with a neutral /path/to/your/nv-ingest-dev/... path and Python 3.12, consistent with requires-python >= 3.12.

Motivation / context

Addresses review feedback on confusing environment naming (Conda vs uv venv), wrong venv name in path checks, inaccurate in-container environment description, and unprofessional / incorrect example paths and Python version in CLI output.

[greptile-apps]

Greptile Summary

This documentation-only PR adds two new setup steps to the Docker Compose quickstart: step i walks users through creating a uv-based Python 3.12 virtual environment named nv-ingest-dev and installing the pinned client packages on the host, while step j explains how to enter the container directly. It also replaces an internal filesystem path and incorrect Python 3.10 reference in the NLTK CLI sample output with a neutral placeholder and the correct Python 3.12 version.

Confidence Score: 5/5

Documentation-only change with no runtime impact; safe to merge.

All findings are P2 style suggestions (a minor path placeholder inconsistency and a missing uv prerequisite note). No logic, security, or correctness issues are present. The changes are a net improvement over the previous state.

No files require special attention.

Important Files Changed

Filename	Overview
docs/docs/extraction/quickstart-guide.md	Adds steps i–j for host-side uv venv setup, in-container workflow, and corrects the NLTK CLI sample path/Python version; minor inconsistency between the new venv name (nv-ingest-dev) and the placeholder used in the NLTK sample output (venv).

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Start: docker compose up] --> B[Step h: docker ps — confirm containers Up]
    B --> C{Where to run client?}
    C -->|Host machine| D["Step i: uv venv nv-ingest-dev\nuv pip install nv-ingest==26.1.2 ..."]
    D --> E[Activate venv & run Python examples]
    C -->|Inside container| F["Step j: docker exec -it\nnv-ingest-nv-ingest-ms-runtime-1 bash"]
    F --> G["/workspace shell — uv venv at /opt/nv_ingest_runtime"]
    G --> H[Run nv-ingest-cli or Python examples]
    E --> I[Step 2: Ingest Documents]
    H --> I

Loading

Comments Outside Diff (1)

1. docs/docs/extraction/quickstart-guide.md, line 314-315 (link)

   NLTK path uses generic venv instead of nv-ingest-dev

   The sample output shows /path/to/your/venv/lib/python3.12/..., but step i names the virtual environment nv-ingest-dev. Using the actual venv name makes the sample output consistent with the setup instructions on line 107 and matches what the PR description promised (/path/to/your/nv-ingest-dev/...).

   Prompt To Fix With AI

   This is a comment left during a code review.
   Path: docs/docs/extraction/quickstart-guide.md
   Line: 314-315
   
   Comment:
   **NLTK path uses generic `venv` instead of `nv-ingest-dev`**
   
   The sample output shows `/path/to/your/venv/lib/python3.12/...`, but step i names the virtual environment `nv-ingest-dev`. Using the actual venv name makes the sample output consistent with the setup instructions on line 107 and matches what the PR description promised (`/path/to/your/nv-ingest-dev/...`).
   
   
   
   How can I resolve this? If you propose a fix, please make it concise.

Prompt To Fix All With AI

This is a comment left during a code review.
Path: docs/docs/extraction/quickstart-guide.md
Line: 314-315

Comment:
**NLTK path uses generic `venv` instead of `nv-ingest-dev`**

The sample output shows `/path/to/your/venv/lib/python3.12/...`, but step i names the virtual environment `nv-ingest-dev`. Using the actual venv name makes the sample output consistent with the setup instructions on line 107 and matches what the PR description promised (`/path/to/your/nv-ingest-dev/...`).

```suggestion
[nltk_data]     /path/to/your/nv-ingest-dev/lib/python3.12/site-
```

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: docs/docs/extraction/quickstart-guide.md
Line: 104-110

Comment:
**`uv` prerequisite not mentioned**

Step i assumes `uv` is already installed, but the guide does not tell the reader how to get it. Users coming to this guide fresh may hit `command not found: uv`. Consider adding a short sentence (or a link to the prerequisites page) noting that `uv` must be installed first, e.g.:

> If `uv` is not already installed, run `curl -LsSf https://astral.sh/uv/install.sh | sh` or see the [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/).

How can I resolve this? If you propose a fix, please make it concise.

_{Reviews (1): Last reviewed commit: "Merge branch '26.03' into kheiss/5966239" | Re-trigger Greptile}

[greptile-apps]

uv prerequisite not mentioned

Step i assumes uv is already installed, but the guide does not tell the reader how to get it. Users coming to this guide fresh may hit command not found: uv. Consider adding a short sentence (or a link to the prerequisites page) noting that uv must be installed first, e.g.:

If uv is not already installed, run curl -LsSf https://astral.sh/uv/install.sh | sh or see the uv installation docs.

Prompt To Fix With AI

This is a comment left during a code review.
Path: docs/docs/extraction/quickstart-guide.md
Line: 104-110

Comment:
**`uv` prerequisite not mentioned**

Step i assumes `uv` is already installed, but the guide does not tell the reader how to get it. Users coming to this guide fresh may hit `command not found: uv`. Consider adding a short sentence (or a link to the prerequisites page) noting that `uv` must be installed first, e.g.:

> If `uv` is not already installed, run `curl -LsSf https://astral.sh/uv/install.sh | sh` or see the [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/).

How can I resolve this? If you propose a fix, please make it concise.