[lbliii]

Description

Adds a no-auth local flow for generating the Python API reference. npm run generate:library:local (or make docs-generate-library-local) runs fern/scripts/generate-library-local.sh, which temporarily injects a path-based nemo-curator-local library entry into docs.yml, runs Fern's docs md generate --local (Docker, no Fern login), and restores docs.yml on exit.

The entry is injected rather than committed because the Fern CLI has two conflicting rules (verified in fern-api/fern source, present in 5.50.4 and latest 5.65.5):

• fern docs md generate --local requires a path input (git inputs are remote-only and need auth), but
• fern docs dev / fern generate --docs reject any docs.yml containing a path input library ("'path' input which is not yet supported. Please use 'git' input.") and render a blank page. fern check does not catch this.

CI and publish/preview workflows are pinned to --library nemo-curator so the git-based remote generation path is unchanged. Also bumps the Fern CLI pin to 5.50.4 and documents both flows in fern/README.md, fern/AUTODOCS_GUIDE.md, and the docs agent skill.

Usage

cd fern
npm run generate:library:local   # no Fern auth; requires Docker
npm run generate:library         # full reference via git; needs fern login or FERN_TOKEN

Checklist

• I am familiar with the Contributing Guide.
• New or Existing tests cover these changes.
• The documentation is up to date with these changes.

Made with Cursor

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[greptile-apps]

Greptile Summary

This PR adds a local, no-auth path for generating the Python API reference using Docker (fern docs md generate --local), working around the Fern CLI's constraint that --local only accepts path-based library inputs while fern docs dev rejects them. A shell script temporarily injects the path entry into docs.yml, runs generation, and restores the file via a trap.

• CI is unchanged functionally: both preview and publish workflows now explicitly pass --library nemo-curator, ensuring only the git-based remote entry is processed and the nemo-curator-local path entry never appears in the committed docs.yml.
• New developer workflow: npm run generate:library:local (or make docs-generate-library-local) invokes the script, which uses awk to inject the temporary nemo-curator-local block, runs Fern with Docker, and restores docs.yml on exit.
• Fern CLI bumped from 5.29.0 to 5.50.4 in fern.config.json; the local script reads this version dynamically, while other package.json scripts still pin to @latest.

Confidence Score: 5/5

Safe to merge — all CI paths use the committed git-based library entry and are unaffected by the new local flow.

The change is confined to documentation, a new developer-only shell script, and adding the --library nemo-curator flag to CI steps. The nemo-curator-local path entry is never committed to docs.yml, so fern generate --docs and fern docs dev in CI see no change. The shell script is well-guarded (set -euo pipefail, pre-flight grep checks, trap-based restore), and the Fern CLI version bump is straightforward.

fern/scripts/generate-library-local.sh — the docs.yml.bak backup file is not gitignored, which could lead to accidental staging after an interrupted run.

Important Files Changed

Filename	Overview
fern/scripts/generate-library-local.sh	New script that temporarily injects a path-based library entry, runs local Fern generation via Docker, and restores docs.yml via trap; solid guards, but docs.yml.bak is not gitignored
.github/workflows/publish-fern-docs.yml	Now pins library generation step to --library nemo-curator, ensuring only the git-based entry is processed; fern generate --docs publish step is unaffected since nemo-curator-local is not committed to docs.yml
.github/workflows/fern-docs-preview-comment.yml	Identical --library nemo-curator pin added to library generation step; safe change
fern/docs.yml	Only adds a comment block warning against committing path-input library entries; no functional YAML change
fern/fern.config.json	Bumps Fern CLI pin from 5.29.0 to 5.50.4; the local generation script reads this version dynamically
fern/package.json	Adds generate:library:local script pointing to the new shell script; generate:library gets --library nemo-curator flag
Makefile	Adds docs-generate-library-local target delegating to the shell script; docs-generate-library updated with --library flag and clarified description

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Developer] -->|npm run generate:library:local| B[generate-library-local.sh]
    B --> C{docs.yml has nemo-curator-local?}
    C -->|Yes - abort| D[Exit: committed path entry breaks fern docs dev]
    C -->|No| E[cp docs.yml docs.yml.bak / trap to restore on EXIT]
    E --> F[awk injects nemo-curator-local path entry into docs.yml]
    F --> G[npx fern-api@5.50.4 docs md generate --local --library nemo-curator-local]
    G --> H[Docker pulls fernapi/fern-python-library-docs-parser]
    H --> I[MDX written to product-docs/.../Full-Library-Reference]
    I --> J[trap fires: mv docs.yml.bak docs.yml]
    J --> K[docs.yml restored]
    A2[CI: push tag / PR] -->|fern docs md generate --library nemo-curator| L[Fern cloud generation git-based, needs FERN_TOKEN]
    L --> M[MDX written to product-docs/.../Full-Library-Reference]
    M --> N[fern generate --docs publish / preview]

Loading

%%{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[Developer] -->|npm run generate:library:local| B[generate-library-local.sh]
    B --> C{docs.yml has nemo-curator-local?}
    C -->|Yes - abort| D[Exit: committed path entry breaks fern docs dev]
    C -->|No| E[cp docs.yml docs.yml.bak / trap to restore on EXIT]
    E --> F[awk injects nemo-curator-local path entry into docs.yml]
    F --> G[npx fern-api@5.50.4 docs md generate --local --library nemo-curator-local]
    G --> H[Docker pulls fernapi/fern-python-library-docs-parser]
    H --> I[MDX written to product-docs/.../Full-Library-Reference]
    I --> J[trap fires: mv docs.yml.bak docs.yml]
    J --> K[docs.yml restored]
    A2[CI: push tag / PR] -->|fern docs md generate --library nemo-curator| L[Fern cloud generation git-based, needs FERN_TOKEN]
    L --> M[MDX written to product-docs/.../Full-Library-Reference]
    M --> N[fern generate --docs publish / preview]

Loading

_{Reviews (3): Last reviewed commit: "docs(fern): inject local library entry a..." | Re-trigger Greptile}

[greptile-apps]

Shared output path produces silently smaller reference on local machines

Both nemo-curator and nemo-curator-local write to the same Full-Library-Reference/ directory. Running generate:library:local after generate:library overwrites the full 424-page set with the beta Docker-parsed subset. A developer iterating locally may not notice the missing pages until they compare output sizes. The docs call this out, but a runtime guard — even just an echo warning — in the Makefile/npm script that the local flow produces fewer pages and overwrites any previous full generation would prevent confusion.

[lbliii]

Pushed 9e68e26: the committed nemo-curator-local (input.path) entry in docs.yml turned out to break fern docs dev — the docs config parser throws Library '...' uses 'path' input which is not yet supported. Please use 'git' input. and renders a blank page (reproduced by @chtruong814 in Voice-Agent; the throw exists in every fern-api release through latest 5.65.5, and fern check doesn't catch it).

Since docs md generate --local requires a path input while docs dev rejects one, the entry now lives only in fern/scripts/generate-library-local.sh, which injects it into docs.yml, generates, and restores the file on exit. npm run generate:library:local / make docs-generate-library-local are unchanged from the caller's perspective, and fern docs dev keeps working.

[github-actions]

🌿 Preview your docs: https://nvidia-preview-lbliii-test-fern-unauth-docs.docs.buildwithfern.com/nemo/curator

[sarahyurick]

/ok to test 9e68e26