docs(extraction): move Starter kits to examples/README.md (#2266 follow-up)#2276
Open
kheiss-uwzoo wants to merge 7 commits into
Open
docs(extraction): move Starter kits to examples/README.md (#2266 follow-up)#2276kheiss-uwzoo wants to merge 7 commits into
kheiss-uwzoo wants to merge 7 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.
Contributor
Greptile SummaryThis PR consolidates the Starter Kits documentation by deleting
|
| 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"]
%%{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"]
Reviews (5): Last reviewed commit: "docs(extraction): fix audit findings for..." | 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.
4 tasks
Correct misleading overview/getting-started links, normalize air-gap Helm URL to main, and polish examples README link text.
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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