fix(docs): repair Starter kits redirect loop breaking docs.nvidia.com links after PR 2195#2266
Conversation
Move notebooks index to extraction/starter-kits.md so mkdocs-redirects legacy entries no longer overwrite notebooks/index.html with a self-redirect. Fixes broken Notebooks and Integrations links from the overview page after PR 2195.
Greptile SummaryThis PR fixes a self-redirect loop on
|
| Filename | Overview |
|---|---|
| docs/mkdocs.yml | Redirect map fixed: extraction/notebooks/index.md and extraction/notebooks.md now correctly point to extraction/starter-kits.md, avoiding the index.md collision. Nav entry also updated. |
| docs/docs/extraction/starter-kits.md | Renamed from notebooks/index.md; H1 updated to 'Starter Kits for NeMo Retriever Library'; relative links corrected from ../../ prefix to ../ (one level shallower from the new location). |
| docs/docs/extraction/overview.md | Both Notebooks links retargeted to starter-kits.md; link text on line 52 still reads 'Notebooks' rather than 'Starter kits'. |
| docs/docs/extraction/agentic-retrieval-concept.md | Single link updated from notebooks/index.md to starter-kits.md; no issues. |
| docs/docs/extraction/concepts.md | Link retargeted to starter-kits.md; link text 'Jupyter examples' retained (minor label drift from page title). |
| docs/docs/extraction/deployment-options.md | Link retargeted to starter-kits.md; link text 'Jupyter Notebooks' retained (minor label drift from page title). |
| docs/docs/extraction/getting-started-about.md | Link retargeted to starter-kits.md; link text 'Jupyter Notebooks' retained. |
| docs/docs/extraction/workflow-e2e-blueprints.md | Link retargeted to starter-kits.md; link text 'Starter kits' already matches the new page title. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph Before["Before (broken — PR #2195)"]
A1["/extraction/notebooks/"] -->|redirect stub overwrites| B1["notebooks/index.html\n(url=./)"]
B1 -->|self-redirect loop| B1
C1["notebooks.md"] -->|redirect| B1
D1["integrations-langchain-llamaindex-haystack.md"] -->|redirect| B1
end
subgraph After["After (this PR)"]
A2["/extraction/notebooks/"] -->|redirect → ../starter-kits/| E2["/extraction/starter-kits/\n(real content)"]
C2["notebooks.md"] -->|redirect| E2
D2["integrations-langchain-llamaindex-haystack.md"] -->|redirect| E2
end
%%{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
subgraph Before["Before (broken — PR #2195)"]
A1["/extraction/notebooks/"] -->|redirect stub overwrites| B1["notebooks/index.html\n(url=./)"]
B1 -->|self-redirect loop| B1
C1["notebooks.md"] -->|redirect| B1
D1["integrations-langchain-llamaindex-haystack.md"] -->|redirect| B1
end
subgraph After["After (this PR)"]
A2["/extraction/notebooks/"] -->|redirect → ../starter-kits/| E2["/extraction/starter-kits/\n(real content)"]
C2["notebooks.md"] -->|redirect| E2
D2["integrations-langchain-llamaindex-haystack.md"] -->|redirect| E2
end
Reviews (2): Last reviewed commit: "fix(docs): align starter-kits H1 with na..." | Re-trigger Greptile
Rename page heading to Starter Kits for NeMo Retriever Library so it matches the sidebar entry and /extraction/starter-kits/ URL.
Summary
Fixes broken Starter kits / Notebooks links on docs.nvidia.com after PR #2195 consolidated integration docs.
PR #2195 correctly removed standalone pages and added
mkdocs-redirectsentries, but two redirect targets pointed atextraction/notebooks/index.md. The redirects plugin treatsindex.mdand the builtindex.htmlas the same output path, so redirect stubs overwrote the real Starter kits page with a self-redirect (url=./). Browsers then loop forever on/extraction/notebooks/.This PR moves the canonical page to
extraction/starter-kits.mdand points legacy URLs at that page instead ofnotebooks/index.md.Problem (live site today)
Verified on https://docs.nvidia.com/nemo/retriever/26.5.0/extraction/overview/ after the automated docs.nvidia.com publish:
Redirecting...,url=./)HTTP 200 alone is not sufficient — the notebooks path is unusable in a browser.
Root cause:
mkdocs-redirectsissue class documented in mkdocs/mkdocs-redirects#24 and #36 — do not redirect to a nestedindex.mdthat is also the canonical build output.PR #2195 redirect map (broken):
Fix
extraction/notebooks/index.md→extraction/starter-kits.md(matches nav label "Starter kits" from remove custom-metadata.md; canonical path is vdbs + notebooks #2195).starter-kits.md.extraction/starter-kits.md(safe — not an index collision):Local
mkdocs buildresult after fix:/extraction/starter-kits/— full content page/extraction/notebooks/— redirect →../starter-kits//extraction/integrations-langchain-llamaindex-haystack/— redirect →../starter-kits//extraction/custom-metadata/— redirect →../vdbs/#metadata-and-filtering(unchanged; republish will replace stale S3 copy)After merge
Run NRL documentation — docs.nvidia.com publish (live) so
aws s3 sync --deletereplaces stalecustom-metadata/HTML and refreshes overview/nav from currentmain.Test plan
mkdocs build -f docs/mkdocs.yml --strictlocally — no redirect-target warnings/extraction/starter-kits/index.htmlcontains page content (not redirect stub)/extraction/notebooks/index.htmlredirects to../starter-kits//extraction/integrations-langchain-llamaindex-haystack/index.htmlredirects to../starter-kits/custom-metadata/page replaced by redirect tovdbs/#metadata-and-filteringRelated