Skip to content

fix(docs): regenerate the release tables stranded by #12110 - #12985

Merged
dagil-nvidia merged 2 commits into
mainfrom
dagil-nvidia/regen-release-tables-after-12110
Aug 11, 2026
Merged

fix(docs): regenerate the release tables stranded by #12110#12985
dagil-nvidia merged 2 commits into
mainfrom
dagil-nvidia/regen-release-tables-after-12110

Conversation

@dagil-nvidia

@dagil-nvidia dagil-nvidia commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

main currently fails the gen-llms-tables-check pre-commit hook, so every open PR fails it
regardless of content — #12977 touches only .github/codeowners/ and still went red on it.

The cause is a merge-order gap between two of my own PRs:

  1. docs: restructure the compatibility page and correct platform data #12529 landed the hook, with its outputs current.
  2. docs(api): generate typed language references with rendered docstrings #12110 then changed the source, components/releases.data.ts — correcting the
    dynamo-config crate link from 1.3.0 to 1.2.1, because crates.io was never republished for
    1.3.0 — without regenerating the artifacts built from it.

#12110 predated the hook, so nothing on that branch caught it. The staleness only became visible
once both were on main.

This is not only a CI fix

Regenerating propagates that same correction into releases.json,
releases-machine-readable.mdx, and release-artifacts.mdx, which still advertise:

cargo add dynamo-config@1.3.0

That command resolves to a version crates.io does not have. The published docs currently tell
readers to install something that does not exist.

Changes

Three files, all generator output, no hand edits:

  • docs/fern/assets/releases.json
  • docs/fern/pages/reference/general/releases-machine-readable.mdx
  • docs/fern/pages/reference/general/release-artifacts.mdx

Validation

  • gen_llms_tables.py --check exits 1 on main before this change and 0 after.
  • Diff is exactly the 1.3.01.2.1 propagation; nothing else moves.

🤖 Generated with Claude Code


Open in Devin Review

Summary by CodeRabbit

  • Documentation
    • Corrected the listed dynamo-config release artifact version from 1.3.0 to 1.2.1 across release metadata and reference documentation.

main fails the gen-llms-tables-check pre-commit hook, so every open PR fails
it too regardless of content -- #12977 touches only .github/codeowners and
still went red on it.

Cause is a merge-order gap between two of my own PRs. #12529 landed the hook
with its outputs current. #12110 then changed the source,
components/releases.data.ts, correcting the dynamo-config crate link from
1.3.0 to 1.2.1 because crates.io was never republished for 1.3.0 -- but did
not regenerate the artifacts built from it. #12110 predated the hook, so
nothing on that branch caught it, and the staleness only became visible once
both were on main.

Regenerating propagates that same correction into releases.json,
releases-machine-readable.mdx and release-artifacts.mdx, which still advertise
'cargo add dynamo-config@1.3.0' -- a command that resolves to a version
crates.io does not have. So this is not only a green-CI fix; the published
docs currently tell readers to install something that does not exist.

No hand edits: the three files are the generator's output, unmodified.

Validation: gen_llms_tables.py --check exits 0 after regeneration, and
exits 1 on main before it.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia requested a review from a team as a code owner August 11, 2026 00:28
@github-actions github-actions Bot added fix documentation Improvements or additions to documentation labels Aug 11, 2026

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@coderabbitai

coderabbitai Bot commented Aug 11, 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: 48da437c-3a8f-4f08-ab49-c85f6244273b

📥 Commits

Reviewing files that changed from the base of the PR and between bb5b141 and 05362b5.

📒 Files selected for processing (3)
  • docs/fern/assets/releases.json
  • docs/fern/pages/reference/general/release-artifacts.mdx
  • docs/fern/pages/reference/general/releases-machine-readable.mdx

Walkthrough

The release metadata and documentation update dynamo-config artifact references from version 1.3.0 to 1.2.1.

Changes

Release artifact version alignment

Layer / File(s) Summary
Update release version references
docs/fern/assets/releases.json, docs/fern/pages/reference/general/release-artifacts.mdx, docs/fern/pages/reference/general/releases-machine-readable.mdx
The download URL, Cargo installation snippets, and release inventories now reference dynamo-config version 1.2.1.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation regeneration caused by issue #12110.
Description check ✅ Passed The description explains the cause, affected files, changes, validation, and related issues, but it omits the required template headings.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

@dagil-nvidia
dagil-nvidia enabled auto-merge (squash) August 11, 2026 00:35
Second stale generator on main, same class as the release tables in the
previous commit and blocking every PR the same way: gen_python_api.py --check
fails on pristine origin/main, so any PR that runs pre-merge inherits it.

Cause is #12820 (fix(frontend): return SGLang chat logprobs), which moved code
in components/src/dynamo/frontend/. The reference deep-links to exact source
lines, so shifting sglang_processor.py and sglang_prepost.py by ~54 and ~104
lines invalidated eight of them. Nothing about the docstrings changed; the line
anchors did.

That is worth noting for anyone editing that package: this reference goes stale
on any line-number shift in the source it documents, not only on docstring
edits. #12820 had no way to know -- the generator landed with #12110 after it
was already open.

Output only, no hand edits.

Validation: all four generators (--check on python, rust, kubernetes, plus
gen_llms_tables) now pass on this branch; python and llms_tables both fail on
pristine main.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 8853852

@github-actions

Copy link
Copy Markdown
Contributor

@dagil-nvidia
dagil-nvidia merged commit 3836d50 into main Aug 11, 2026
101 checks passed
@dagil-nvidia
dagil-nvidia deleted the dagil-nvidia/regen-release-tables-after-12110 branch August 11, 2026 01:11
dagil-nvidia added a commit that referenced this pull request Aug 11, 2026
Clean auto-merge. Picks up #12985, which unbroke the two stale generated
artifacts on main -- this PR was failing pre-commit on those, not on anything
it changes.

Validation: 88 tests pass; CODEOWNERS regenerates byte-identical to main, so
the advisory removal still changes no routing.

Signed-off-by: Dan Gil <dagil@nvidia.com>
dagil-nvidia added a commit that referenced this pull request Aug 11, 2026
Clean auto-merge. Picks up #12985, which unbroke the two stale generated
artifacts on main -- this PR was failing pre-commit on those rather than on
its own content.

Validation: docs_lint --scan docs exits 0; the aggregator needs list still
resolves all 11 entries to defined jobs.

Signed-off-by: Dan Gil <dagil@nvidia.com>
dagil-nvidia added a commit that referenced this pull request Aug 12, 2026
…elf-heal

Two gaps found pressure-testing this, both of which matter more now that the
publish gate is staying blocking rather than being relaxed.

Blast radius. The happy path pushes to main unreviewed, so an unbounded diff
is the one way this job can do real damage: a merge that moves a documented
symbol touches a handful of pages, but a BROKEN generator rewrites all of
them. Real regenerations for scale -- #12985 was 4 files, #13035 was 6 -- so
the cap is 20 files or 2000 lines. Over that, the direct push is skipped
entirely and the change goes to a branch for review.

Silent failure. The job previously exited 0 after falling back to a branch.
With the gate blocking, a fallback is not a nuisance, it is a publish outage:
main carries stale references and docs.nvidia.com will not update until
someone opens that PR. A green run hides exactly that, which is how
update-events.yml failed 100 times without anyone noticing. The job now fails
on the fallback path and routes through notify-slack.yml, the same notifier
nightly and post-merge already use.

Deliberate asymmetry: pushing to main is a success, falling back is a
failure. Both leave the tree correct; only one leaves the publish blocked.

Validation: YAML parses, both jobs resolve, every run: block passes bash -n.
Signed-off-by: Dan Gil <dagil@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants