Merged
Conversation
sosahi
approved these changes
Mar 11, 2026
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.
Fix documentation build warnings and broken references
Summary
Resolves MkDocs build warnings and broken links reported during
mkdocs build, so the docs build completes cleanly without nav/link errors.Changes
Navigation (
docs/mkdocs.yml)API Reference: extraction/api-docsThe path
extraction/api-docsdoes not exist. The existing “Use the API” item already points toextraction/python-api-reference.md.Links and anchors
docs/docs/extraction/user-defined-functions.md../../../config/default_pipeline.yaml(outside the docs tree, so MkDocs reported “target not found”) with a stable GitHub URL:https://github.com/NVIDIA/nv-ingest/blob/main/config/default_pipeline.yamldocs/docs/extraction/content-metadata.md#nearbyobjectsschema→### \NearbyObjectsSchema` (Currently Unused)`#errormetadataschema→### \ErrorMetadataSchema` (Currently Unused)`#infomessagemetadataschema→### \InfoMessageMetadataSchema` (Currently Unused)`Build impact
After these changes, the following are addressed:
A reference to 'extraction/api-docs' is included in the 'nav' configuration, which is not foundDoc file 'extraction/user-defined-functions.md' contains a link ... but the target ... is not found among documentation filesDoc file 'extraction/content-metadata.md' contains a link '#errormetadataschema' (#infomessagemetadataschema, #nearbyobjectsschema), but there is no such anchor on this pageTesting
mkdocs build -f docs/mkdocs.yml(or fromdocs/:mkdocs build) and confirm no nav/link warnings for the above items.Notes
client/uv.lockand any other non-docs changes on the branch are unrelated to this fix.