Skip to content

Commit 85b490a

Browse files
authored
fix(docs): repair Starter kits redirect loop breaking docs.nvidia.com links after PR 2195 (#2266)
1 parent 6dde47f commit 85b490a

8 files changed

Lines changed: 17 additions & 16 deletions

File tree

docs/docs/extraction/agentic-retrieval-concept.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ NeMo Retriever Library focuses on document ingestion, embeddings, vector stores,
77
**Related**
88

99
- [Semantic retrieval](vdbs.md#semantic-retrieval)
10-
- Framework examples: [Starter kits](notebooks/index.md)
10+
- Framework examples: [Starter kits](starter-kits.md)

docs/docs/extraction/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ Token-based splitting uses the Llama 3.2 1B tokenizer (default `meta-llama/Llama
3636

3737
- **Library mode** — Run without the full container stack where appropriate; see [Deployment options](deployment-options.md).
3838
- **Kubernetes / Helm (self-hosted)** — See [Deploy (Helm chart)](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) and [deployment options](deployment-options.md) for running the full microservices pipeline on your infrastructure.
39-
- **Notebooks**[Jupyter examples](notebooks/index.md) for experimentation and RAG demos.
39+
- **Notebooks**[Jupyter examples](starter-kits.md) for experimentation and RAG demos.
4040

4141
For a concise comparison, refer to [Deployment options](deployment-options.md).

docs/docs/extraction/deployment-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For audio and video extraction in Kubernetes, set `service.installFfmpeg=true` s
2828

2929
### I want examples and notebooks
3030

31-
1. [Jupyter Notebooks](notebooks/index.md)
31+
1. [Jupyter Notebooks](starter-kits.md)
3232

3333
### I need API details and keys
3434

docs/docs/extraction/getting-started-about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Typical order:
99
3. Deploy using one of:
1010
- [Deployment options](deployment-options.md) for how to run NeMo Retriever Library
1111
- **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) for Kubernetes, plus [NeMo Retriever Library install docs](https://docs.nvidia.com/nemo/retriever/latest/extraction/overview/) for the published charts
12-
4. Explore [Jupyter Notebooks](notebooks/index.md) for end-to-end examples.
12+
4. Explore [Jupyter Notebooks](starter-kits.md) for end-to-end examples.
1313

1414
If you are new to the product, read [What is NeMo Retriever Library?](overview.md) and [Concepts](concepts.md) under **Introduction** first.

docs/docs/extraction/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ NeMo Retriever Library supports the following file types:
4949
- [Deployment options](deployment-options.md) — library, Helm, hosted vs self-hosted NIMs in one place
5050
- [Deploy on Kubernetes with Helm](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md)
5151
- [NeMo Retriever Library — prerequisites / deployment](https://docs.nvidia.com/nemo/retriever/latest/extraction/overview/) (supported Helm charts)
52-
- [Notebooks](notebooks/index.md)
53-
- [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Starter kits](notebooks/index.md).
52+
- [Notebooks](starter-kits.md)
53+
- [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Starter kits](starter-kits.md).
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Notebooks for NeMo Retriever Library
1+
# Starter Kits for NeMo Retriever Library
22

3-
To get started using [NeMo Retriever Library](../overview.md), you can try one of the ready-made notebooks that are available.
3+
To get started using [NeMo Retriever Library](overview.md), you can try one of the ready-made notebooks that are available.
44

55
## Dataset Downloads for Benchmarking
66

@@ -10,9 +10,9 @@ If you plan to run benchmarking or evaluation tests, you must download the [Benc
1010

1111
To get started with the basics, try one of the following guides or notebooks:
1212

13-
- [Quickstart: retriever CLI](../../reference/retriever-cli-quickstart.md)
14-
- [Workflow: Ingest documents](../workflow-document-ingestion.md)
15-
- [Adding Custom Metadata for Filtered Search/Retrieval](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/nemo_retriever_retriever_query_metadata_filter.ipynb) — also summarized on [Vector databases — Metadata and filtering](../vdbs.md#metadata-and-filtering)
13+
- [Quickstart: retriever CLI](../reference/retriever-cli-quickstart.md)
14+
- [Workflow: Ingest documents](workflow-document-ingestion.md)
15+
- [Adding Custom Metadata for Filtered Search/Retrieval](https://github.com/NVIDIA/NeMo-Retriever/blob/main/examples/nemo_retriever_retriever_query_metadata_filter.ipynb) — also summarized on [Vector databases — Metadata and filtering](vdbs.md#metadata-and-filtering)
1616

1717

1818
For more advanced scenarios, try one of the following notebooks:

docs/docs/extraction/workflow-e2e-blueprints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Use these external resources for end-to-end RAG implementations with NeMo Retrie
55
- [Enterprise RAG - multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)
66
- [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover)
77

8-
For framework-specific integration patterns, refer to [Starter kits](notebooks/index.md).
8+
For framework-specific integration patterns, refer to [Starter kits](starter-kits.md).

docs/mkdocs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ nav:
102102
- Extending/Customizing NeMo Retriever Library with custom code: https://github.com/NVIDIA/NeMo-Retriever/tree/main/nemo_retriever/src/nemo_retriever/graph#nemo-retriever-graph
103103
- "NimClient and custom NIM endpoints": extraction/nimclient.md
104104
- "9. Integrations & ecosystem":
105-
- "Starter kits": extraction/notebooks/index.md
105+
- "Starter kits": extraction/starter-kits.md
106106
- "10. Evaluation & benchmarks":
107107
- "Evaluate on your own documents": extraction/evaluate-on-your-data.md
108108
- "11. Reference":
@@ -157,10 +157,11 @@ plugins:
157157
extraction/hosted-nims-when-to-use.md: extraction/deployment-options.md
158158
extraction/releasenotes-nv-ingest.md: extraction/releasenotes.md
159159
extraction/ngc-api-key.md: extraction/api-keys.md
160-
extraction/notebooks.md: extraction/notebooks/index.md
160+
extraction/notebooks/index.md: extraction/starter-kits.md
161+
extraction/notebooks.md: extraction/starter-kits.md
161162
extraction/data-store.md: extraction/vdbs.md
162163
extraction/custom-metadata.md: extraction/vdbs.md#metadata-and-filtering
163-
extraction/integrations-langchain-llamaindex-haystack.md: extraction/notebooks/index.md
164+
extraction/integrations-langchain-llamaindex-haystack.md: extraction/starter-kits.md
164165
extraction/nemoretriever-parse.md: extraction/multimodal-extraction.md#text-and-layout-extraction
165166
extraction/supported-file-types.md: extraction/multimodal-extraction.md#supported-file-types-and-formats
166167
extraction/text-layout-extraction.md: extraction/multimodal-extraction.md#text-and-layout-extraction
@@ -209,7 +210,7 @@ markdown_extensions:
209210

210211
# MkDocs 1.6+: exclude suite landing and legacy duplicate pages (still in repo for parity).
211212
# extraction/chunking.md — removed from nav; content is under concepts.md (redirect_maps keeps old URLs).
212-
# Use /index.md (docs root only); bare index.md would exclude every index.md (e.g. extraction/notebooks/index.md).
213+
# Use /index.md (docs root only); bare index.md would exclude every index.md (e.g. under subfolders).
213214
exclude_docs: |
214215
/index.md
215216
extraction/chunking.md

0 commit comments

Comments
 (0)