docs: crosslink Python API guide adjacent to python snippets#2246
Closed
kheiss-uwzoo wants to merge 1 commit into
Closed
docs: crosslink Python API guide adjacent to python snippets#2246kheiss-uwzoo wants to merge 1 commit into
kheiss-uwzoo wants to merge 1 commit into
Conversation
Add same-section links to nemo-retriever-api-reference.md on extraction pages where python fences lacked an adjacent API guide crosslink.
Collaborator
Author
|
Superseded by combined draft PR #2245. |
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
1 participant
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
Apply reviewer guidance: every
```pythonfence on extraction doc pages should have a same-section crosslink to the Python API guide (per.cursor/rules/nrl-python-snippet-api-crosslinks.mdc).Updated pages
embedding.md— one crosslink per example section (three##sections)audio-video.md— hosted Parakeet example (Helm section already had a link)custom-metadata.md—Retriever.queryfilter example (pseudocode block unchanged)nimclient.md— section-level crosslinks for ModelInterface, UDF, error-handling, and debugging sectionsAlready compliant (no changes):
workflow-document-ingestion.md,faq.md,vdbs.md,custom-metadata.md(ingest snippet),audio-video.md(Helm snippet).Test plan
rg '```python' docs/docs/extraction -lvs pages withnemo-retriever-api-referencein same section