docs(extraction): move NimClient guide from published docs to developer_docs#2284
Conversation
Follow-up to PR NVIDIA#2257 review: consolidate developer-facing NimClient content with the graph package README and remove it from published extraction nav, with a redirect for legacy nimclient URLs.
Greptile SummaryThis PR relocates the NimClient usage guide from the published MkDocs site (
|
| Filename | Overview |
|---|---|
| docs/mkdocs.yml | Removes nimclient nav entry from section 8 and adds a redirect from the old URL to the new GitHub blob location; follows the same external-URL redirect pattern already used for user-defined-stages. |
| nemo_retriever/developer_docs/README.md | Adds a single table row indexing the new nimclient.md alongside other internal guides; no issues. |
| nemo_retriever/developer_docs/nimclient.md | Content moved and updated with corrected module paths; has a UTF-8 BOM character at the start and a minor inconsistency between the env-var example value (NIM_MAX_RETRIES=5) and the documented function default (max_retries=10). |
| nemo_retriever/src/nemo_retriever/graph/README.md | Adds a two-line crosslink to the new NimClient developer doc; relative path resolves correctly. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Legacy URL\n/extraction/nimclient/"] -->|mkdocs redirect| B["GitHub blob\nnemo_retriever/developer_docs/nimclient.md"]
C["docs/mkdocs.yml nav\n(section 8)"] -- removed --> D["NimClient entry ❌"]
E["nemo_retriever/developer_docs/README.md"] -->|indexed| B
F["nemo_retriever/src/nemo_retriever/graph/README.md"] -->|crosslink| B
B -->|relative link| F
%%{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["Legacy URL\n/extraction/nimclient/"] -->|mkdocs redirect| B["GitHub blob\nnemo_retriever/developer_docs/nimclient.md"]
C["docs/mkdocs.yml nav\n(section 8)"] -- removed --> D["NimClient entry ❌"]
E["nemo_retriever/developer_docs/README.md"] -->|indexed| B
F["nemo_retriever/src/nemo_retriever/graph/README.md"] -->|crosslink| B
B -->|relative link| F
Reviews (3): Last reviewed commit: "docs(extraction): polish NimClient devel..." | Re-trigger Greptile
Align with PR NVIDIA#2257 review: relocate developer-facing NimClient content from published extraction docs into nemo_retriever/developer_docs, index it in developer_docs/README.md, and redirect legacy nimclient URLs.
Fix encoding, title case, default max_retries drift, and consolidate duplicate API guide crosslinks before PR review.
Summary
Follow-up to PR #2257 per Randy's review: the NimClient usage guide is developer-facing content and should not be a formal published extraction page.
docs/docs/extraction/nimclient.mdtonemo_retriever/developer_docs/nimclient.mdnemo_retriever/developer_docs/README.mddocs/mkdocs.ymlextraction/nimclient.mdto the developer docs file for legacy URLsmainmodule locationsTest plan
check-nrl-doc-leakage.ps1 -Base mainpasses on the branch diff/extraction/nimclient/URLs redirect tonemo_retriever/developer_docs/nimclient.md