Skip to content

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

Open
kheiss-uwzoo wants to merge 7 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 7 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 consolidates the Starter Kits documentation by deleting docs/docs/extraction/starter-kits.md and replacing all its inbound links with direct references to the new examples/README.md on GitHub, following up on reviewer feedback from #2266.

  • Removed extraction/starter-kits.md; content migrated to examples/README.md with published docs.nvidia.com URLs for cross-links and relative paths for in-repo notebooks (all of which exist in examples/).
  • Updated docs/mkdocs.yml: nav entry for "Starter kits" now points to the external GitHub URL, and redirect_maps covers the old extraction/starter-kits.md, extraction/notebooks.md, extraction/notebooks/index.md, and extraction/integrations-langchain-llamaindex-haystack.md paths — all valid usage of the mkdocs-redirects plugin.
  • Updated six extraction doc pages to link directly to the GitHub README instead of the now-deleted local page.

Confidence Score: 5/5

Documentation-only change with no logic, no code, and no API surface — safe to merge.

All nine changed files are Markdown or YAML documentation. The mkdocs-redirects plugin supports external URLs as redirect targets, the nav external URL is valid MkDocs syntax, and every relative notebook path in examples/README.md resolves to a file that exists in the repository.

No files require special attention.

Important Files Changed

Filename Overview
examples/README.md New starter-kits README added with correct relative links to all notebooks that exist in examples/; docs.nvidia.com URLs used for cross-links to published docs.
docs/mkdocs.yml Nav entry updated to external GitHub URL (valid MkDocs syntax); redirect_maps correctly adds extraction/starter-kits.md and updates notebooks/integrations entries to external GitHub URL, supported by mkdocs-redirects.
docs/docs/extraction/starter-kits.md File deleted; content moved to examples/README.md; a redirect entry in mkdocs.yml covers the old URL.
docs/docs/extraction/deployment-options.md Starter-kit notebook link updated; audio/video Kubernetes paragraph replaced with a short reference to audio-video.md — deliberate consolidation.
docs/docs/extraction/overview.md Two links updated from starter-kits.md to GitHub examples/README.md URL.
docs/docs/extraction/concepts.md Single notebook link updated from starter-kits.md to GitHub examples/README.md URL.
docs/docs/extraction/agentic-retrieval-concept.md Single starter-kits link updated to GitHub examples/README.md URL.
docs/docs/extraction/getting-started-about.md Single notebook link updated from starter-kits.md to GitHub examples/README.md URL.
docs/docs/extraction/workflow-e2e-blueprints.md Single starter-kits link updated to GitHub examples/README.md URL.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["docs site visitor\n(old URL)"] -->|"extraction/starter-kits.md\nnotebooks.md etc."| B["mkdocs-redirects\n(redirect_maps)"]
    B -->|"HTTP redirect"| C["github.com/.../examples/README.md"]
    D["docs site nav\n'Starter kits'"] -->|"external link"| C
    E["docs cross-links"] -->|"absolute GitHub URL"| C
    C -->|"relative links"| F["examples/*.ipynb"]
    C -->|"docs.nvidia.com URLs"| G["Published docs site"]
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["docs site visitor\n(old URL)"] -->|"extraction/starter-kits.md\nnotebooks.md etc."| B["mkdocs-redirects\n(redirect_maps)"]
    B -->|"HTTP redirect"| C["github.com/.../examples/README.md"]
    D["docs site nav\n'Starter kits'"] -->|"external link"| C
    E["docs cross-links"] -->|"absolute GitHub URL"| C
    C -->|"relative links"| F["examples/*.ipynb"]
    C -->|"docs.nvidia.com URLs"| G["Published docs site"]
Loading

Reviews (5): Last reviewed commit: "docs(extraction): fix audit findings for..." | 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