fix MkDocs nav, macro conflicts, and internal links - #1927
Conversation
Greptile SummaryThis PR fixes documentation build failures in the NeMo Retriever Extraction docs by correcting a broken
|
| 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.md → content-metadata.md and nimclient_usage.md → nimclient.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]
Reviews (1): Last reviewed commit: "Fixing file issues for doc build" | Re-trigger Greptile
Summary
Fixes documentation build failures and warnings under
docs/for the NeMo Retriever Extraction section.Changes
mkdocs.ymlreferencedextraction/api-docs, which does not exist. Point Reference → API Reference atextraction/python-api-reference.mdso the nav matches published pages.air-gapped-deployment.md({{index .RepoDigests 0}}) with{% raw %}…{% endraw %}so it is not parsed as Jinja.{#…}with explicit HTML<a id="…"></a>anchors incontent-metadata.mdfor the three affected headings so they are not treated as Jinja comments.environment-variables.md→environment-config.md(chunking.md,content-metadata.md)troubleshooting.md→troubleshoot.md(scaling-modes.md)metadata_documentation.md→content-metadata.md(user-defined-functions.md)nimclient_usage.md→nimclient.md(user-defined-functions.md)Verification
mkdocs buildcompletes without the previous nav, macro syntax, or missing-doc warnings for these paths..