docs(extraction): move Starter kits to examples/README.md (#2266 follow-up)#2276
docs(extraction): move Starter kits to examples/README.md (#2266 follow-up)#2276kheiss-uwzoo wants to merge 9 commits into
Conversation
Follow-up to NVIDIA#2266 (Randy review): remove the duplicate starter-kits doc page, host notebook links in examples/README.md, and point nav/redirects and cross-links at the GitHub README.
Greptile SummaryThis PR consolidates the "Starter Kits" documentation by deleting
|
| Filename | Overview |
|---|---|
| examples/README.md | New file: migrated starter-kit content with relative links to notebooks (all verified to exist in examples/) and docs.nvidia.com absolute links for cross-docs references. |
| docs/mkdocs.yml | Nav entry for 'Starter kits' changed to external GitHub URL; four redirect_maps entries updated to external GitHub URL — consistent with existing external-URL redirect pattern already used in this file. |
| docs/docs/extraction/starter-kits.md | Deleted; content moved to examples/README.md and legacy path covered by mkdocs redirect. |
| docs/docs/extraction/deployment-options.md | Notebook link updated; audio/video Kubernetes paragraph consolidated to a reference to audio-video.md, which already contains the service.installFfmpeg=true detail. |
| docs/docs/extraction/overview.md | Notebooks link and Starter kits reference updated to GitHub URL; bullet split into two for readability. |
| docs/docs/extraction/concepts.md | Single cross-link updated from starter-kits.md to the GitHub examples README URL. |
| docs/docs/extraction/getting-started-about.md | Single cross-link updated from starter-kits.md to the GitHub examples README URL. |
| docs/docs/extraction/agentic-retrieval-concept.md | Single cross-link updated from starter-kits.md to the GitHub examples README URL. |
| docs/docs/extraction/workflow-e2e-blueprints.md | Single cross-link updated from starter-kits.md to the GitHub examples README URL. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User visits legacy URL
/extraction/starter-kits/
/extraction/notebooks/
/extraction/integrations-*/] -->|mkdocs-redirects| B[GitHub examples/README.md]
C[Sidebar: Starter kits nav entry] -->|external link| B
D[Cross-links in docs
overview · concepts · deployment-options
getting-started-about · workflow-e2e-blueprints
agentic-retrieval-concept] -->|absolute GitHub URL| B
B --> E[Relative .ipynb links
building_vdb_operator.ipynb
langchain_multimodal_rag.ipynb
llama_index_multimodal_rag.ipynb
nemo_retriever_..._filter.ipynb]
B --> F[docs.nvidia.com absolute links
Quickstart · Ingest workflow
Vector databases · Overview]
B --> G[External absolute links
build.nvidia.com · evaluation/*.ipynb]
style B fill:#76b900,color:#fff
%%{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
A[User visits legacy URL
/extraction/starter-kits/
/extraction/notebooks/
/extraction/integrations-*/] -->|mkdocs-redirects| B[GitHub examples/README.md]
C[Sidebar: Starter kits nav entry] -->|external link| B
D[Cross-links in docs
overview · concepts · deployment-options
getting-started-about · workflow-e2e-blueprints
agentic-retrieval-concept] -->|absolute GitHub URL| B
B --> E[Relative .ipynb links
building_vdb_operator.ipynb
langchain_multimodal_rag.ipynb
llama_index_multimodal_rag.ipynb
nemo_retriever_..._filter.ipynb]
B --> F[docs.nvidia.com absolute links
Quickstart · Ingest workflow
Vector databases · Overview]
B --> G[External absolute links
build.nvidia.com · evaluation/*.ipynb]
style B fill:#76b900,color:#fff
Reviews (7): Last reviewed commit: "Merge branch 'main' into docs/starter-ki..." | Re-trigger Greptile
Fix see/refer-to link CTAs in concepts.md, tighten examples/README.md prose, and dedupe the air-gapped audio/video warning in deployment-options.
Resolve conflicts in concepts.md, getting-started-about.md, and overview.md: keep examples/README.md links from this PR and adopt main deployment wording.
Correct misleading overview/getting-started links, normalize air-gap Helm URL to main, and polish examples README link text.
Resolve conflict in getting-started-about.md: keep main's deployment wording and NVAIE note; retain PR link to examples/README.md.
Summary
Follow-up to #2266 per @randerzander review: delete the duplicate extraction/starter-kits.md doc page, move its content to examples/README.md, and link the TOC and legacy redirects directly to that GitHub README.
Test plan
Related