Skip to content

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

Open
kheiss-uwzoo wants to merge 9 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 9 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 moving its content to a new examples/README.md in the repository root, then redirecting all cross-links and legacy redirects in mkdocs.yml to the GitHub-hosted README.

  • New examples/README.md: Content migrated from starter-kits.md; docs cross-links updated to docs.nvidia.com URLs, while in-repo notebook links use relative paths (all target .ipynb files verified to exist in examples/).
  • docs/mkdocs.yml: Nav entry for "Starter kits" and four legacy redirect paths (notebooks/index.md, notebooks.md, starter-kits.md, integrations-langchain-llamaindex-haystack.md) now point to the GitHub README URL — consistent with the external-URL redirect pattern already used in this file.
  • Six extraction docs: Cross-links updated from the local starter-kits.md relative path to the full GitHub URL; deployment-options.md also consolidates audio/video Kubernetes guidance into a reference to audio-video.md, which already contains the service.installFfmpeg=true detail.

Confidence Score: 5/5

Pure documentation reorganization with no logic or runtime changes — safe to merge.

All changes are Markdown and YAML documentation files. The new examples/README.md uses relative links verified to resolve to existing notebooks in the examples/ directory. The external-URL redirect pattern in mkdocs.yml was already established in the same file before this PR. The deployment-options.md content reduction is fully covered by audio-video.md. No code, configuration, or schema is touched.

No files require special attention.

Important Files Changed

Filename Overview
examples/README.md New file: migrated starter-kit content with relative links to notebooks (all verified to exist in examples/) and docs.nvidia.com absolute links for cross-docs references.
docs/mkdocs.yml Nav entry for 'Starter kits' changed to external GitHub URL; four redirect_maps entries updated to external GitHub URL — consistent with existing external-URL redirect pattern already used in this file.
docs/docs/extraction/starter-kits.md Deleted; content moved to examples/README.md and legacy path covered by mkdocs redirect.
docs/docs/extraction/deployment-options.md Notebook link updated; audio/video Kubernetes paragraph consolidated to a reference to audio-video.md, which already contains the service.installFfmpeg=true detail.
docs/docs/extraction/overview.md Notebooks link and Starter kits reference updated to GitHub URL; bullet split into two for readability.
docs/docs/extraction/concepts.md Single cross-link updated from starter-kits.md to the GitHub examples README URL.
docs/docs/extraction/getting-started-about.md Single cross-link updated from starter-kits.md to the GitHub examples README URL.
docs/docs/extraction/agentic-retrieval-concept.md Single cross-link updated from starter-kits.md to the GitHub examples README URL.
docs/docs/extraction/workflow-e2e-blueprints.md Single cross-link updated from starter-kits.md to the GitHub examples README URL.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User visits legacy URL
/extraction/starter-kits/
/extraction/notebooks/
/extraction/integrations-*/] -->|mkdocs-redirects| B[GitHub examples/README.md]
    C[Sidebar: Starter kits nav entry] -->|external link| B
    D[Cross-links in docs
overview · concepts · deployment-options
getting-started-about · workflow-e2e-blueprints
agentic-retrieval-concept] -->|absolute GitHub URL| B
    B --> E[Relative .ipynb links
building_vdb_operator.ipynb
langchain_multimodal_rag.ipynb
llama_index_multimodal_rag.ipynb
nemo_retriever_..._filter.ipynb]
    B --> F[docs.nvidia.com absolute links
Quickstart · Ingest workflow
Vector databases · Overview]
    B --> G[External absolute links
build.nvidia.com · evaluation/*.ipynb]
    style B fill:#76b900,color:#fff
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
/extraction/starter-kits/
/extraction/notebooks/
/extraction/integrations-*/] -->|mkdocs-redirects| B[GitHub examples/README.md]
    C[Sidebar: Starter kits nav entry] -->|external link| B
    D[Cross-links in docs
overview · concepts · deployment-options
getting-started-about · workflow-e2e-blueprints
agentic-retrieval-concept] -->|absolute GitHub URL| B
    B --> E[Relative .ipynb links
building_vdb_operator.ipynb
langchain_multimodal_rag.ipynb
llama_index_multimodal_rag.ipynb
nemo_retriever_..._filter.ipynb]
    B --> F[docs.nvidia.com absolute links
Quickstart · Ingest workflow
Vector databases · Overview]
    B --> G[External absolute links
build.nvidia.com · evaluation/*.ipynb]
    style B fill:#76b900,color:#fff
Loading

Reviews (7): 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
Resolve conflict in getting-started-about.md: keep main's deployment
wording and NVAIE note; retain PR link to examples/README.md.
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