Skip to content

fix MkDocs nav, macro conflicts, and internal links - #1927

Merged
kheiss-uwzoo merged 1 commit into
NVIDIA:26.03from
kheiss-uwzoo:kheiss/26.03-filefixes
Apr 24, 2026
Merged

fix MkDocs nav, macro conflicts, and internal links#1927
kheiss-uwzoo merged 1 commit into
NVIDIA:26.03from
kheiss-uwzoo:kheiss/26.03-filefixes

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

Fixes documentation build failures and warnings under docs/ for the NeMo Retriever Extraction section.

Changes

  • Navigationmkdocs.yml referenced extraction/api-docs, which does not exist. Point Reference → API Reference at extraction/python-api-reference.md so the nav matches published pages.
  • mkdocs-macros — Escape the Docker Go template in air-gapped-deployment.md ({{index .RepoDigests 0}}) with {% raw %}…{% endraw %} so it is not parsed as Jinja.
  • mkdocs-macros — Replace pymdown-style heading ids {#…} with explicit HTML <a id="…"></a> anchors in content-metadata.md for the three affected headings so they are not treated as Jinja comments.
  • Internal links — Update targets to files that exist in the repo:
    • environment-variables.mdenvironment-config.md (chunking.md, content-metadata.md)
    • troubleshooting.mdtroubleshoot.md (scaling-modes.md)
    • metadata_documentation.mdcontent-metadata.md (user-defined-functions.md)
    • nimclient_usage.mdnimclient.md (user-defined-functions.md)

Verification

  • mkdocs build completes without the previous nav, macro syntax, or missing-doc warnings for these paths..

@kheiss-uwzoo
kheiss-uwzoo requested a review from a team as a code owner April 24, 2026 23:01
@kheiss-uwzoo
kheiss-uwzoo requested review from edknv and removed request for a team April 24, 2026 23:01
@greptile-apps

greptile-apps Bot commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR fixes documentation build failures in the NeMo Retriever Extraction docs by correcting a broken mkdocs.yml nav entry, escaping a Docker Go template to prevent Jinja parsing errors, replacing pymdown-style heading IDs with explicit HTML anchors, and updating five internal links that pointed to non-existent files. All target files (python-api-reference.md, environment-config.md, troubleshoot.md, content-metadata.md, nimclient.md) exist in the repo, and the existing intra-page anchor references (#nearbyobjectsschema, etc.) remain valid with the new <a id> tags.

Confidence Score: 5/5

This PR is safe to merge — all changes are documentation fixes with no code impact.

All six changed files are Markdown/YAML documentation. Every target file referenced by the corrected links exists in the repo. Intra-page anchor IDs are unchanged after the {#id} → conversion. No remaining references to the old filenames were found across the docs tree. No logic, API, or runtime behavior is affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/mkdocs.yml Corrects nav entry from non-existent extraction/api-docs to extraction/python-api-reference.md, which exists in the repo.
docs/docs/extraction/air-gapped-deployment.md Wraps Docker Go template {{index .RepoDigests 0}} in {% raw %}…{% endraw %} to prevent mkdocs-macros from treating it as Jinja.
docs/docs/extraction/content-metadata.md Replaces three pymdown {#id} heading anchors with explicit <a id> HTML anchors and fixes environment-variables.md link to environment-config.md; intra-page anchor references remain consistent.
docs/docs/extraction/chunking.md Updates broken environment-variables.md link to correct environment-config.md.
docs/docs/extraction/scaling-modes.md Updates broken troubleshooting.md link to correct troubleshoot.md.
docs/docs/extraction/user-defined-functions.md Fixes two broken links: metadata_documentation.mdcontent-metadata.md and nimclient_usage.mdnimclient.md.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[mkdocs build] --> B{Nav entry\nextraction/api-docs}
    B -- was missing --> C[❌ Build error]
    B -- fixed to extraction/python-api-reference.md --> D[✅ Nav resolves]

    A --> E{Jinja macro\nprocessing}
    E -- raw Go template\n'{{index .RepoDigests 0}}' --> F[❌ Macro parse error]
    E -- wrapped in raw...endraw --> G[✅ Template passed through]

    A --> H{pymdown\nheading IDs}
    H -- '#id' parsed as Jinja comment --> I[❌ Macro conflict]
    H -- replaced with HTML anchor tags --> J[✅ Anchors preserved]

    A --> K{Internal links}
    K -- environment-variables.md\ntroubleshooting.md\nmetadata_documentation.md\nnimclient_usage.md --> L[❌ Missing doc warnings]
    K -- environment-config.md\ntroubleshoot.md\ncontent-metadata.md\nnimclient.md --> M[✅ Links resolve]
Loading

Reviews (1): Last reviewed commit: "Fixing file issues for doc build" | Re-trigger Greptile

@kheiss-uwzoo
kheiss-uwzoo merged commit 0ee2699 into NVIDIA:26.03 Apr 24, 2026
3 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant