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 5 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 completes the follow-up from #2266 by deleting
|
| Filename | Overview |
|---|---|
| examples/README.md | New GitHub README consolidating starter-kit notebook links; relative .ipynb paths all resolve correctly to existing files in examples/ |
| docs/docs/extraction/starter-kits.md | Deleted; content migrated to examples/README.md and legacy path covered by a new redirect in mkdocs.yml |
| docs/mkdocs.yml | Nav entry and four redirects updated to point to the GitHub examples/README.md; external-URL redirects are already used elsewhere in the same plugin block, so the pattern is established |
| docs/docs/extraction/deployment-options.md | Cross-links updated; ffmpeg/Kubernetes paragraph condensed (content preserved in audio-video.md); air-gapped warning now links to a 26.05-pinned Helm README URL while the Related section below still uses main — inconsistent within the same file |
| docs/docs/extraction/overview.md | Starter-kits link updated to GitHub URL; a new docs.nvidia.com bullet for prerequisites/deployment added |
| docs/docs/extraction/concepts.md | Single cross-link update from starter-kits.md to the GitHub examples README |
| docs/docs/extraction/getting-started-about.md | Notebooks link updated to GitHub URL; Helm chart bullet extended with a docs.nvidia.com link for published charts |
| docs/docs/extraction/workflow-e2e-blueprints.md | Single cross-link update from starter-kits.md to the GitHub examples README |
| docs/docs/extraction/agentic-retrieval-concept.md | Single cross-link update from starter-kits.md to the GitHub examples README |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["User visits legacy URL\n(starter-kits, notebooks,\nintegrations-langchain…)"] -->|mkdocs-redirects| B["GitHub: examples/README.md"]
C["MkDocs nav\n'9. Integrations & ecosystem\n→ Starter kits'"] --> B
D["Cross-links in 6 extraction docs\n(overview, concepts, deployment-options,\ngetting-started-about,\nworkflow-e2e-blueprints,\nagentic-retrieval-concept)"] --> B
B --> E["Relative .ipynb links\n(examples/*.ipynb — verified present)"]
B --> F["docs.nvidia.com links\n(workflow, vdbs, CLI quickstart)"]
B --> G["Absolute GitHub links\n(evaluation/bo767_recall.ipynb,\nEnterprise RAG Blueprint)"]
%%{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\n(starter-kits, notebooks,\nintegrations-langchain…)"] -->|mkdocs-redirects| B["GitHub: examples/README.md"]
C["MkDocs nav\n'9. Integrations & ecosystem\n→ Starter kits'"] --> B
D["Cross-links in 6 extraction docs\n(overview, concepts, deployment-options,\ngetting-started-about,\nworkflow-e2e-blueprints,\nagentic-retrieval-concept)"] --> B
B --> E["Relative .ipynb links\n(examples/*.ipynb — verified present)"]
B --> F["docs.nvidia.com links\n(workflow, vdbs, CLI quickstart)"]
B --> G["Absolute GitHub links\n(evaluation/bo767_recall.ipynb,\nEnterprise RAG Blueprint)"]
Reviews (3): 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.
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