Skip to content

docs(extraction): move Starter kits to examples/README.md (#2266 follow-up)#2276

Open
kheiss-uwzoo wants to merge 5 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/starter-kits-to-examples-readme
Open

docs(extraction): move Starter kits to examples/README.md (#2266 follow-up)#2276
kheiss-uwzoo wants to merge 5 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/starter-kits-to-examples-readme

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

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.

  • Add examples/README.md with starter-kit notebook links (docs cross-links use published docs.nvidia.com URLs; in-repo notebooks use relative paths).
  • Remove docs/docs/extraction/starter-kits.md.
  • Update docs/mkdocs.yml nav (Starter kits) and redirects (notebooks, starter-kits, integrations-langchain-llamaindex-haystack) to the GitHub examples README.
  • Update extraction cross-links in overview, concepts, deployment-options, getting-started-about, workflow-e2e-blueprints, and agentic-retrieval-concept.

Test plan

  • mkdocs build -f docs/mkdocs.yml --strict — redirects for legacy paths resolve to GitHub README
  • Sidebar Starter kits opens GitHub examples/README.md
  • /extraction/starter-kits/ and /extraction/notebooks/ redirect to GitHub README after republish
  • Overview and related cross-links resolve to GitHub README

Related

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.
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 26, 2026 21:55
@kheiss-uwzoo kheiss-uwzoo requested a review from drobison00 June 26, 2026 21:55
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 26, 2026 21:55
@greptile-apps

greptile-apps Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR completes the follow-up from #2266 by deleting docs/docs/extraction/starter-kits.md, replacing it with a new examples/README.md in the repo root, and updating all cross-links and MkDocs redirects to point at the GitHub file.

  • Deleted docs/docs/extraction/starter-kits.md; content is preserved in the new examples/README.md, with docs-site links converted to docs.nvidia.com URLs and notebook links kept as relative paths (all four .ipynb files verified to exist in examples/).
  • Updated docs/mkdocs.yml nav and four legacy redirects (notebooks/index.md, notebooks.md, starter-kits.md, integrations-langchain-llamaindex-haystack.md) to the GitHub README; the external-URL redirect pattern is already established elsewhere in the same plugin block.
  • Updated six extraction doc pages with the new cross-link; deployment-options.md also condenses its ffmpeg/Kubernetes paragraph into a reference to audio-video.md, where that content now lives in full.

Confidence Score: 5/5

Safe to merge — pure documentation reorganization with no code changes; all notebook links in the new README resolve to existing files.

All changed files are documentation only. The new examples/README.md is self-consistent, its relative notebook links point to files that exist in examples/, and the external redirect pattern in mkdocs.yml mirrors what was already in use for other legacy paths. The only wrinkle is a version-pinned Helm README URL (26.05) in the air-gapped warning that is inconsistent with every other Helm link in the same file — a cosmetic issue that does not affect functionality.

The 26.05-pinned Helm README URL inside the air-gapped warning in docs/docs/extraction/deployment-options.md is inconsistent with the main-branch links used everywhere else in that file.

Important Files Changed

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)"]
Loading
%%{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)"]
Loading

Reviews (3): Last reviewed commit: "Merge branch 'main' into docs/starter-ki..." | Re-trigger Greptile

 follow-up)

Replace installFfmpeg and service.image prose with one-line links to
audio-video.md and the Helm air-gapped guide per page-role rules.
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jun 26, 2026
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 26, 2026
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.
@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review July 1, 2026 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant