Skip to content

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

Open
kheiss-uwzoo wants to merge 4 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 4 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 deletes docs/docs/extraction/starter-kits.md and consolidates its content into a new examples/README.md, then updates every in-docs cross-link and the MkDocs nav/redirect configuration to point at the GitHub README instead.

  • Added examples/README.md with starter-kit notebook links (relative paths for same-directory notebooks, docs.nvidia.com absolute URLs for published-doc cross-links).
  • Removed docs/docs/extraction/starter-kits.md and added a redirect_maps entry plus three legacy-path redirects (notebooks/index.md, notebooks.md, integrations-langchain-llamaindex-haystack.md) all targeting the GitHub README.
  • Updated six extraction docs (overview, concepts, deployment-options, getting-started-about, workflow-e2e-blueprints, agentic-retrieval-concept) to replace relative starter-kits.md links with the GitHub README URL.

Confidence Score: 5/5

Documentation-only change; all broken relative links are replaced with working GitHub absolute URLs and legacy redirect paths are registered in mkdocs.yml.

The restructuring is mechanically straightforward — deleted file, new README, updated links, and redirect entries. The only nit is a version-pinned branch reference (26.05) introduced in one warning block that is inconsistent with every other GitHub link in the same file, but it does not break anything today.

docs/docs/extraction/deployment-options.md — contains a 26.05 branch-pinned link in the air-gapped warning block while all surrounding links use /main/.

Important Files Changed

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

Reviews (2): Last reviewed commit: "Merge upstream/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