Skip to content

docs(operator): update API reference footer and regenerate Fern docs - #14353

Merged
PeaBrane merged 2 commits into
ai-dynamo:mainfrom
elizabetht:fix/fern-errors
Sep 6, 2026
Merged

PeaBrane merged 2 commits into
ai-dynamo:mainfrom
elizabetht:fix/fern-errors

Conversation

@elizabetht

@elizabetht elizabetht commented Sep 4, 2026 •

Copy link
Copy Markdown
Contributor

Overview:

PR 14076 — feat(operator)!: migrate checkpoints to standalone Snapshot deleted deploy/operator/internal/checkpoint/resource.go, leaving the footer link stale.

Details:

  • Remove the link from deploy/operator/docs/footer.md.
  • Regenerate api-reference-k8s.md and full-api-reference.mdx to propagate the change.

Where should the reviewer start?

Start with deploy/operator/docs/footer.md. The other two files contain the corresponding

Related Issues

⚠️ This section is required. Choose one path below and delete the other.

Relates to #14076

Summary by CodeRabbit

  • Documentation
    • Removed internal implementation-reference links from operator default-values and checkpoint/restore API documentation.

Signed-off-by: Elizabeth Thomas <email2eliza@gmail.com>
@elizabetht
elizabetht requested review from a team as code owners September 4, 2026 22:21
@copy-pr-bot

copy-pr-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

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.

@elizabetht
elizabetht temporarily deployed to external_collaborator September 4, 2026 22:21 — with GitHub Actions Inactive
@elizabetht
elizabetht temporarily deployed to external_collaborator September 4, 2026 22:21 — with GitHub Actions Inactive
@github-actions

github-actions Bot commented Sep 4, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot added docs external-contribution Pull request is from an external contributor documentation Improvements or additions to documentation deployment::k8s Relates to dynamo deployment in kubernetes labels Sep 4, 2026
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 22e35cf4-2974-4d68-a064-5b8097c7360b

📥 Commits

Reviewing files that changed from the base of the PR and between 68bb983 and 64fe88d.

📒 Files selected for processing (3)
  • deploy/operator/docs/footer.md
  • docs/fern/pages/reference/kubernetes-api/additional-resources/api-reference-k8s.md
  • docs/fern/pages/reference/kubernetes-api/full-api-reference.mdx
💤 Files with no reviewable changes (3)
  • deploy/operator/docs/footer.md
  • docs/fern/pages/reference/kubernetes-api/additional-resources/api-reference-k8s.md
  • docs/fern/pages/reference/kubernetes-api/full-api-reference.mdx

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

Changes

Checkpoint documentation

Layer / File(s) Summary
Remove implementation references
deploy/operator/docs/footer.md, docs/fern/pages/reference/kubernetes-api/...
Removed internal/checkpoint/resource.go links from three checkpoint and restore documentation pages.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 64fe8

This change removes stale documentation links to a deleted implementation file and updates generated API reference pages. No current merge-readiness risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the documentation update and regeneration of the Fern API reference files. It is concise and related to the main change.
Description check ✅ Passed The description explains the stale link, lists the changed files, and identifies where to start the review. The Related Issues section references #14076, but the sentence about the regenerated files i…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

@elizabetht

Copy link
Copy Markdown
Contributor Author

@PeaBrane
PeaBrane enabled auto-merge (squash) September 6, 2026 05:51
@PeaBrane

PeaBrane commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

/ok to test acff2cd

@PeaBrane
PeaBrane merged commit c70f1c7 into ai-dynamo:main Sep 6, 2026
103 checks passed
jain-ria added a commit that referenced this pull request Sep 18, 2026
Remove the obsolete checkpoint source link and regenerate the operator references, adopt the split ModelExpress refit examples, and link the GB200 recipe to the release branch where it remains available.

Adapted from #14353 and #14774; all replacement targets return HTTP 200.

Signed-off-by: jain-ria <riajain@NVIDIA.com>
jain-ria added a commit that referenced this pull request Sep 18, 2026
Remove the obsolete checkpoint source link and regenerate the operator references, adopt the split ModelExpress refit examples, and link the GB200 recipe to the release branch where it remains available.

Adapted from #14353 and #14774; all replacement targets return HTTP 200.

Signed-off-by: jain-ria <riajain@NVIDIA.com>

This branch was previously deployed

1 inactive deployment
external_collaborator — acff2cd3 Deployed Sep 5, 2026 by elizabetht via ok-to-test #15362
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deployment::k8s Relates to dynamo deployment in kubernetes docs documentation Improvements or additions to documentation external-contribution Pull request is from an external contributor size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants