remove custom-metadata.md; canonical path is vdbs + notebooks#2195
remove custom-metadata.md; canonical path is vdbs + notebooks#2195kheiss-uwzoo wants to merge 14 commits into
Conversation
Greptile SummaryThis PR consolidates two standalone documentation pages (
|
| 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)"]
Reviews (12): Last reviewed commit: "Merge branch 'main' into docs/consolidat..." | Re-trigger Greptile
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.
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