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 4 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 deletes
|
| Filename | Overview |
|---|---|
| examples/README.md | New starter-kits landing page; uses relative paths for same-directory notebooks and absolute docs.nvidia.com URLs for published-docs cross-links — consistent and correct. |
| docs/docs/extraction/starter-kits.md | Deleted; content migrated to examples/README.md with a redirect registered in mkdocs.yml. |
| docs/mkdocs.yml | Nav entry and four redirect_maps targets updated from the deleted starter-kits.md to the GitHub examples README; follows the same external-URL redirect pattern already established for other legacy paths. |
| docs/docs/extraction/deployment-options.md | Starter-kits links updated correctly; air-gapped warning block reformatted but introduces a version-pinned branch reference (26.05) inconsistent with the /main/ links used everywhere else in the file. |
| docs/docs/extraction/overview.md | Starter-kits references replaced with GitHub README URL; adds a link to the published docs overview for Helm charts. |
| docs/docs/extraction/getting-started-about.md | Notebook link updated to GitHub README; existing Helm chart link supplemented with a published-docs cross-link. |
| docs/docs/extraction/concepts.md | Single-line change replacing the relative starter-kits.md link with the GitHub README URL. |
| docs/docs/extraction/agentic-retrieval-concept.md | Single-line change replacing the relative starter-kits.md link with the GitHub README URL. |
| docs/docs/extraction/workflow-e2e-blueprints.md | Single-line change replacing the relative starter-kits.md link with the GitHub README URL. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["User visits /extraction/starter-kits/\n/extraction/notebooks/\n/extraction/notebooks/index/\n/extraction/integrations-langchain-llamaindex-haystack/"] -->|mkdocs-redirects| B["GitHub: examples/README.md"]
C["MkDocs nav — Starter kits"] -->|external URL| B
D["Inline links in 6 extraction docs\n(overview, concepts, deployment-options,\ngetting-started-about, workflow-e2e-blueprints,\nagentic-retrieval-concept)"] --> B
E["docs/docs/extraction/starter-kits.md"] -->|deleted| F["(removed)"]
B --> G["examples/ notebooks\n(relative .ipynb links)"]
B --> H["docs.nvidia.com published docs\n(absolute URLs)"]
%%{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 /extraction/starter-kits/\n/extraction/notebooks/\n/extraction/notebooks/index/\n/extraction/integrations-langchain-llamaindex-haystack/"] -->|mkdocs-redirects| B["GitHub: examples/README.md"]
C["MkDocs nav — Starter kits"] -->|external URL| B
D["Inline links in 6 extraction docs\n(overview, concepts, deployment-options,\ngetting-started-about, workflow-e2e-blueprints,\nagentic-retrieval-concept)"] --> B
E["docs/docs/extraction/starter-kits.md"] -->|deleted| F["(removed)"]
B --> G["examples/ notebooks\n(relative .ipynb links)"]
B --> H["docs.nvidia.com published docs\n(absolute URLs)"]
Reviews (2): Last reviewed commit: "Merge upstream/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