Skip to content

remove custom-metadata.md; canonical path is vdbs + notebooks#2195

Merged
kheiss-uwzoo merged 23 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/consolidate-custom-metadata-into-vdbs
Jun 24, 2026
Merged

remove custom-metadata.md; canonical path is vdbs + notebooks#2195
kheiss-uwzoo merged 23 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/consolidate-custom-metadata-into-vdbs

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Remove docs/docs/extraction/custom-metadata.md (duplicate of notebook + VDB README content added in align metadata docs with VDB filtering guide #2108).
  • Expand Metadata and filtering on �dbs.md with a short overview and links to the worked notebooks.
  • Drop the separate MkDocs nav entry; add redirect custom-metadata.md -> �dbs.md#metadata-and-filtering.
  • Update cross-links and doc-snippet test registry.

Follows Julio's NVBugs 6205401 guidance: VDB/metadata facts live on �dbs.md; runnable walkthroughs stay in notebooks.

Notebooks (canonical examples)

Operator/API reference remains in nemo_retriever/src/nemo_retriever/vdb/README.md.

Test plan

  • MkDocs build; confirm redirect from old custom-metadata URL
  • Nav no longer lists a separate Custom metadata page
  • Notebook links resolve on GitHub

@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 1, 2026 18:03
@kheiss-uwzoo kheiss-uwzoo requested a review from edknv June 1, 2026 18:03
@greptile-apps

greptile-apps Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR removes custom-metadata.md and integrations-langchain-llamaindex-haystack.md, consolidating metadata guidance into vdbs.md#metadata-and-filtering and framework examples into notebooks/index.md, with MkDocs redirect rules covering the old URLs.

  • Source-path corrections in vdbs.md update stale GitHub links (e.g. vdb/operators.pyoperators/vdb.py, vdb/adt_vdb.pycommon/vdb/adt_vdb.py); the old paths no longer exist in the repo, so these are accurate fixes.
  • The doc-snippet test registry swaps the deleted custom-metadata.md for vdbs.md; Retriever() unsupported-kwargs coverage is preserved via the notebook entry already in _PUBLIC_RETRIEVER_DOCS.

Confidence Score: 5/5

Documentation-only restructuring with no logic changes; the deleted pages are fully covered by redirect rules and the cross-links all point to files that exist.

All changed files are Markdown docs, a YAML nav config, and a test registry update. The source-path corrections in vdbs.md are verified against the actual repo layout (old paths absent, new paths confirmed present). Redirect targets and anchor IDs were checked and are valid. The test change correctly substitutes the deleted file with its replacement in the snippet-validation registry.

docs/docs/extraction/vdbs.md — the #metadata-and-filtering section content and docs/docs/extraction/notebooks/index.md — missing notebook link were flagged in prior review threads and remain open items.

Important Files Changed

Filename Overview
docs/docs/extraction/vdbs.md Source-path corrections (vdb/ → operators/ and common/vdb/) verified against actual repo structure; metadata section reduced to a single sentence (previously flagged in review thread)
docs/mkdocs.yml Nav renumbered and two pages removed; hash-fragment redirects for custom-metadata.md and integrations page follow the same pattern used by existing redirects in this file
nemo_retriever/tests/test_src_documentation_snippets.py Registry updated from deleted custom-metadata.md to vdbs.md; Retriever() unsupported-kwargs coverage maintained through the notebook entry already in _PUBLIC_RETRIEVER_DOCS
docs/docs/extraction/notebooks/index.md Entry text updated and cross-link to vdbs.md added; metadata_and_filtered_search.ipynb still absent (flagged in existing review thread)
docs/docs/extraction/custom-metadata.md File deleted; all content was duplicate of notebook and VDB README; redirect rule added in mkdocs.yml
docs/docs/extraction/integrations-langchain-llamaindex-haystack.md File deleted; redirect to notebooks/index.md added; LangChain and LlamaIndex notebooks still linked from notebooks/index.md

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["custom-metadata.md\n(deleted)"] -->|redirect| B["vdbs.md\n#metadata-and-filtering"]
    C["integrations-langchain-\nllamaindex-haystack.md\n(deleted)"] -->|redirect| D["notebooks/index.md"]

    E["workflow-agentic-retrieval.md"] -->|cross-link updated| B
    F["workflow-e2e-blueprints.md"] -->|cross-link updated| D
    G["agentic-retrieval-concept.md"] -->|cross-link updated| D
    H["overview.md"] -->|cross-link updated| D
    I["deployment-options.md"] -->|removed link to| C

    B -->|references| J["nemo_retriever_retriever_query_\nmetadata_filter.ipynb\n(notebook)"]
    D -->|lists| J

    K["test_src_documentation_snippets.py"] -->|registry: custom-metadata.md → vdbs.md| B
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A["custom-metadata.md\n(deleted)"] -->|redirect| B["vdbs.md\n#metadata-and-filtering"]
    C["integrations-langchain-\nllamaindex-haystack.md\n(deleted)"] -->|redirect| D["notebooks/index.md"]

    E["workflow-agentic-retrieval.md"] -->|cross-link updated| B
    F["workflow-e2e-blueprints.md"] -->|cross-link updated| D
    G["agentic-retrieval-concept.md"] -->|cross-link updated| D
    H["overview.md"] -->|cross-link updated| D
    I["deployment-options.md"] -->|removed link to| C

    B -->|references| J["nemo_retriever_retriever_query_\nmetadata_filter.ipynb\n(notebook)"]
    D -->|lists| J

    K["test_src_documentation_snippets.py"] -->|registry: custom-metadata.md → vdbs.md| B
Loading

Reviews (27): Last reviewed commit: "Merge upstream/main into docs/consolidat..." | Re-trigger Greptile

@kheiss-uwzoo kheiss-uwzoo changed the title docs(extraction): remove custom-metadata.md; canonical path is vdbs + notebooks remove custom-metadata.md; canonical path is vdbs + notebooks Jun 1, 2026
@kheiss-uwzoo kheiss-uwzoo requested a review from jperez999 June 1, 2026 18:12
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jun 1, 2026
Comment thread docs/docs/extraction/integrations-langchain-llamaindex-haystack.md Outdated
Comment thread docs/docs/extraction/vdbs.md
Comment thread docs/docs/extraction/vdbs.md Outdated
Comment thread docs/docs/extraction/notebooks/index.md Outdated
@kheiss-uwzoo kheiss-uwzoo requested a review from randerzander June 5, 2026 17:42
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 5, 2026 23:27
@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review June 8, 2026 20:14
Comment thread docs/docs/extraction/notebooks/index.md Outdated
Comment thread docs/docs/extraction/agentic-retrieval-concept.md Outdated
Comment thread docs/docs/extraction/workflow-e2e-blueprints.md Outdated
@kheiss-uwzoo kheiss-uwzoo requested a review from jperez999 June 11, 2026 15:32
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 11, 2026
kheiss-uwzoo and others added 9 commits June 11, 2026 16:34
Drop dead metadata_and_filtered_search notebook links; document retriever
service sidecar upload on vdbs.md instead of delegating to VDB README.
Delete integrations-langchain-llamaindex-haystack.md, point inbound links at notebooks/index.md, and add a mkdocs redirect.
Replace duplicated metadata prose with a single notebook link per review.
Revert doc-snippet test list change; belongs outside this docs-only PR.
Users arriving via the deleted custom-metadata.md URL need a short
overview of meta_* sidecar params and filter modes, plus links to the
worked notebooks and VDB README—not a bare hyperlink alone.
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Restore vdbs.md metadata landing content with service sidecar guidance, drop dead metadata_and_filtered_search.ipynb links, and point the doc-snippet test registry at vdbs.md instead of deleted custom-metadata.md.
Remove reindex_example.ipynb entry (notebook removed on main in NVIDIA#2163).
Rename framework cross-links to Starter kits to match mkdocs nav label.
@kheiss-uwzoo kheiss-uwzoo force-pushed the docs/consolidate-custom-metadata-into-vdbs branch from a541334 to fafaf61 Compare June 11, 2026 23:35
Resolve modify/delete conflict on custom-metadata.md by keeping the PR
deletion; canonical metadata docs live in vdbs.md with mkdocs redirect.
Comment thread docs/docs/extraction/notebooks/index.md Outdated
Comment thread docs/docs/extraction/notebooks/index.md Outdated
Comment thread docs/docs/extraction/notebooks/index.md Outdated
Comment thread docs/docs/extraction/vdbs.md Outdated
Comment thread docs/docs/extraction/vdbs.md Outdated
kheiss-uwzoo and others added 4 commits June 23, 2026 08:51
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
Update GitHub source paths for the common/vdb and schemas reorg, document
the job-based sidecar ingest API, drop a missing notebook link, and align
link CTAs with the style guide.
Replace duplicated sidecar/API prose with a single notebook pointer so
implementation detail stays in the worked example.
Comment thread docs/docs/extraction/notebooks/index.md Outdated
Comment thread docs/docs/extraction/vdbs.md Outdated
Comment thread docs/docs/extraction/workflow-agentic-retrieval.md Outdated
@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator Author

Opened eng follow-up for Helm deployment guidance in the metadata-filtering notebook: #2261 (assigned @jioffe502 and @jdye64).

Per review: \�dbs.md#metadata-and-filtering\ stays notebook-only (no sidecar / retriever-service prose on the docs page). Part B of \examples/nemo_retriever_retriever_query_metadata_filter.ipynb\ will cover \POST /v1/ingest/sidecar, job-based ingest, and \meta_dataframe_id.

kheiss-uwzoo and others added 3 commits June 23, 2026 09:54
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
Co-authored-by: Randy Gelhausen <rgelhau@gmail.com>
PR NVIDIA#2166 replaced the service.installFfmpeg runtime paragraph with link-only prose; test_container_ffmpeg_install still requires runtime wording in deployment-options.md.
Resolve deployment-options.md conflict by keeping PR ffmpeg guidance
(writable root FS, custom image fallback) and main's air-gapped
alternatives cross-reference.
Comment thread docs/docs/extraction/deployment-options.md
@kheiss-uwzoo kheiss-uwzoo merged commit b5c34f2 into NVIDIA:main Jun 24, 2026
10 checks passed
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Jun 24, 2026
Resolve conflicts with NVIDIA#2195 (custom-metadata and integrations page
removal): keep PR caption/OCR/support-matrix fixes; accept main nav and
redirects for integrations-langchain-llamaindex-haystack.md.
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Jun 26, 2026
Point workflow-document-ingestion at tools/evaluation/README.md; vdbs and custom-metadata link fixes already landed on main via NVIDIA#2195.
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Jun 26, 2026
 follow-up)

Replace installFfmpeg and service.image prose with one-line links to
audio-video.md and the Helm air-gapped guide per page-role rules.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants