remove custom-metadata.md; canonical path is vdbs + notebooks#2195
remove custom-metadata.md; canonical path is vdbs + notebooks#2195kheiss-uwzoo wants to merge 9 commits into
Conversation
Greptile SummaryRemoves two thin doc pages (
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/vdbs.md | Metadata and filtering section expanded with overview prose, sidecar parameter details, service workflow, and links to the worked notebook; cross-links updated throughout. |
| nemo_retriever/tests/test_src_documentation_snippets.py | Swapped custom-metadata.md for vdbs.md in _PUBLIC_RETRIEVER_DOCS; vdbs.md currently has no Python fenced blocks, so the entry contributes zero coverage to the constructor-kwargs and syntax tests. |
| docs/docs/extraction/notebooks/index.md | Both canonical metadata notebooks are now listed; prior thread concern about missing metadata_and_filtered_search.ipynb link is addressed. |
| docs/mkdocs.yml | Removed custom-metadata and integrations nav entries; sections renumbered; two redirects added for deleted pages. |
| docs/docs/extraction/custom-metadata.md | Deleted; content consolidated into vdbs.md and notebooks; redirect configured in mkdocs.yml. |
| docs/docs/extraction/integrations-langchain-llamaindex-haystack.md | Deleted; thin wrapper page replaced by redirect to notebooks/index.md which already lists the LangChain and LlamaIndex examples. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
OLD_CM["custom-metadata.md\n(deleted)"]
OLD_INT["integrations-langchain-llamaindex-haystack.md\n(deleted)"]
REDIRECT1["redirect:\nextraction/custom-metadata.md\n→ vdbs.md#metadata-and-filtering"]
REDIRECT2["redirect:\nextraction/integrations-…\n→ notebooks/index.md"]
VDBS["vdbs.md\n#metadata-and-filtering\n(expanded)"]
NB_INDEX["notebooks/index.md\n(both metadata notebooks listed)"]
NB1["metadata_and_filtered_search.ipynb"]
NB2["nemo_retriever_retriever_query_metadata_filter.ipynb"]
VDB_README["nemo_retriever/src/nemo_retriever/vdb/README.md\n(canonical operator reference)"]
OLD_CM -->|content moved to| VDBS
OLD_CM -->|URL preserved by| REDIRECT1
OLD_INT -->|URL preserved by| REDIRECT2
VDBS -->|worked example link| NB2
VDBS -->|operator reference link| VDB_README
NB_INDEX --> NB1
NB_INDEX --> NB2
Reviews (15): Last reviewed commit: "docs(extraction): address PR2195 review ..." | Re-trigger Greptile
| - [Workflow: Ingest documents](../workflow-document-ingestion.md) | ||
| - [How to add metadata to your documents and filter searches](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/nemo_retriever_retriever_query_metadata_filter.ipynb) | ||
| - [Metadata filtering: add sidecar metadata and filter searches](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/nemo_retriever_retriever_query_metadata_filter.ipynb) | ||
| - [How to reindex a collection](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/reindex_example.ipynb) |
There was a problem hiding this comment.
You sure this is valid? I dont see this file, nor should it exist.
|
|
||
| - [Semantic retrieval](vdbs.md#semantic-retrieval) | ||
| - Framework examples: [LangChain, LlamaIndex, Haystack](integrations-langchain-llamaindex-haystack.md) | ||
| - Framework examples: [Jupyter Notebooks](notebooks/index.md) |
There was a problem hiding this comment.
I cant find this ref either? Is this PR outdated, maybe this should be closed without merge?
There was a problem hiding this comment.
The target page exists at docs/docs/extraction/notebooks/index.md (mkdocs nav: Starter kits). The integrations page this PR removes only duplicated LangChain/LlamaIndex links already listed there.
Main still has both custom-metadata.md and integrations-langchain-llamaindex-haystack.md, so the consolidation is still needed — not planning to close without merge.
Renamed the link text to Starter kits in 0c8878e2 to match the nav label.
| - [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) | ||
|
|
||
| For framework-specific integration patterns, see [Framework integrations](integrations-langchain-llamaindex-haystack.md). | ||
| For framework-specific integration patterns, see [Jupyter Notebooks](notebooks/index.md). |
There was a problem hiding this comment.
Same as above — notebooks/index.md is the Starter kits page; link label updated to match nav in 0c8878e2.
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.
a541334 to
fafaf61
Compare
Summary
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