Skip to content

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

Open
kheiss-uwzoo wants to merge 14 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/consolidate-custom-metadata-into-vdbs
Open

remove custom-metadata.md; canonical path is vdbs + notebooks#2195
kheiss-uwzoo wants to merge 14 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 consolidates two standalone documentation pages (custom-metadata.md and integrations-langchain-llamaindex-haystack.md) into the canonical locations — vdbs.md#metadata-and-filtering and notebooks/index.md — per a documented internal guidance decision. Redirects are added for both deleted URLs, cross-links are updated across six files, the MkDocs nav is renumbered (13 → 12 sections), and the doc-snippet test registry is updated to cover vdbs.md instead of the deleted file.

  • vdbs.md gains a prose overview of sidecar meta_* parameters, the compact-JSON storage detail, server-side where filtering, and the retriever-service upload flow previously scattered across custom-metadata.md.
  • notebooks/index.md swaps the metadata_and_filtered_search.ipynb entry for nemo_retriever_retriever_query_metadata_filter.ipynb in the Getting Started list; LangChain/LlamaIndex notebook links move from the removed integrations page to the existing "advanced scenarios" list already on that page.
  • The mkdocs.yml redirect map gains two new fragment-anchored redirects, consistent with how other section-level redirects (e.g., semantic-hybrid-retrieval.md → vdbs.md#semantic-and-hybrid-retrieval) are already handled.

Confidence Score: 5/5

Safe to merge — documentation-only change with no production code modified.

All changes are Markdown, YAML, and a test-registry update. The two deleted pages are replaced by redirects that follow the same fragment-anchor pattern already in use for other section-level redirects (e.g., semantic-hybrid-retrieval.md → vdbs.md#semantic-and-hybrid-retrieval). The anchor #metadata-and-filtering matches the heading defined on line 90 of vdbs.md. The test registry swap from custom-metadata.md to vdbs.md is correct — vdbs.md exists at the expected repo-root relative path and its Python blocks contain no unsupported Retriever() kwargs. No logic, API, or runtime behavior is affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/docs/extraction/vdbs.md Metadata section expanded with sidecar parameter overview, JSON storage note, service-side upload flow, and worked-example links; two stale cross-links to deleted custom-metadata.md replaced.
docs/docs/extraction/notebooks/index.md Getting-Started entry swapped from metadata_and_filtered_search.ipynb to nemo_retriever_retriever_query_metadata_filter.ipynb; LangChain/LlamaIndex notebooks already present in the Advanced section are unaffected.
docs/mkdocs.yml Two nav sections removed, sections renumbered 7–12; two new fragment-anchored redirects added, consistent with pre-existing pattern for section-level redirects.
nemo_retriever/tests/test_src_documentation_snippets.py _PUBLIC_RETRIEVER_DOCS updated from deleted custom-metadata.md to vdbs.md; vdbs.md exists at the expected repo-root relative path and its Python blocks contain no unsupported Retriever() kwargs.
docs/docs/extraction/custom-metadata.md File deleted; content absorbed into vdbs.md and canonical notebooks. Redirect added in mkdocs.yml.
docs/docs/extraction/integrations-langchain-llamaindex-haystack.md File deleted; notebook links already present in notebooks/index.md advanced section. Redirect to notebooks/index.md added.
docs/docs/extraction/deployment-options.md Removed the integrations-langchain-llamaindex-haystack.md link from the examples and notebooks list; single-item numbered list remains but the content is accurate.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Old URL: custom-metadata.md"] -->|"mkdocs redirect"| B["vdbs.md#metadata-and-filtering"]
    C["Old URL: integrations-langchain-llamaindex-haystack.md"] -->|"mkdocs redirect"| D["notebooks/index.md"]
    B --> E["VDB README (canonical reference)"]
    B --> F["nemo_retriever_retriever_query_metadata_filter.ipynb"]
    D --> F
    D --> G["langchain_multimodal_rag.ipynb\nllama_index_multimodal_rag.ipynb\n(Advanced section — unchanged)"]
Loading

Reviews (12): Last reviewed commit: "Merge branch '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
Drop dead metadata_and_filtered_search notebook links; document retriever
service sidecar upload on vdbs.md instead of delegating to VDB README.
Comment thread docs/docs/extraction/integrations-langchain-llamaindex-haystack.md Outdated
Comment thread docs/docs/extraction/vdbs.md
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.
Comment thread docs/docs/extraction/vdbs.md Outdated
Comment thread docs/docs/extraction/notebooks/index.md
kheiss-uwzoo and others added 4 commits June 5, 2026 08:44
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>
@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
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.
@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review June 8, 2026 20:14
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.

2 participants