Skip to content

docs: give release statistics a visible home on Release History - #12223

Merged
dagil-nvidia merged 5 commits into
dagil-nvidia/compatibility-page-cleanupfrom
dagil-nvidia/release-stats-on-history
Jul 31, 2026
Merged

docs: give release statistics a visible home on Release History#12223
dagil-nvidia merged 5 commits into
dagil-nvidia/compatibility-page-cleanupfrom
dagil-nvidia/release-stats-on-history

Conversation

@dagil-nvidia

@dagil-nvidia dagil-nvidia commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

Stacked on #12215. Base is dagil-nvidia/compatibility-page-cleanup, not main — review that PR first. Rebase onto main and retarget once #12215 merges.

Summary

The reference sidebar hides reference/releases-data.mdx, the machine-readable release mirror. Auditing what that costs a reader turned up exactly one thing: the per-release statistics table — PRs, contributors, first-time contributors, breaking changes, known issues — had no reader-facing home anywhere in the docs. Every other section of that mirror already has a visible equivalent.

This renders those counts onto Release History, so the hidden page holds nothing unique for readers.

What Changed

  • New release-stats generated span on reference/release-notes/README.mdx, using the same marker-keyed mechanism as the support matrix and the same fail-closed behavior: markers absent means the generator errors rather than appending, so placement stays under human control.
  • Rows come from RELEASE_STATS rather than a fixed v1.0.0-v1.3.0 list, so a release added by the per-release bump checklist appears with no edit to the generator.
  • Both the visible table and the agent mirror now build from one release_stats_table helper and cannot drift. The regenerated releases-data.mdx is byte-identical, which confirms the extraction changed no output.
  • Generator output labels are now relative to the reference root, since this is the first page in a subdirectory and several pages are named README.mdx.

Judgement Calls

  • Plain table, not an accordion. Release History is a short page and this is four rows; hiding it would cost more than it saves.
  • Placed after the release timeline under a ## Release statistics heading, matching the section name it had in the mirror so the equivalence is easy to check.
  • A lead-in explains the dash — v1.0.0 has no PR count and v1.2.0 no first-timer count, and a bare - reads as zero otherwise.

Verification

  • gen_llms_tables.py --check clean (idempotent).
  • check_reference.sh: ALL CHECKS PASSED, zero broken links in reference/.
  • fern check: 0 errors.
  • Rendered and screenshotted in both dark and light themes.
  • Fail-closed behavior and the empty-RELEASE_STATS guard exercised directly.

Open in Devin Review

@dagil-nvidia
dagil-nvidia requested a review from a team as a code owner July 27, 2026 21:28
@github-actions github-actions Bot added docs documentation Improvements or additions to documentation labels Jul 27, 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

@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 5d8fb95

The per-release PR, contributor, first-time-contributor, breaking-change
and known-issue counts existed only in reference/releases-data.mdx. That
page is a machine-readable mirror and is deliberately hidden from the
sidebar, so these counts had no reader-facing home anywhere in the docs.
Every other section of that mirror already has a visible equivalent on
Compatibility, Release Artifacts, Model Early Access Builds, or Release
History; this was the one exception.

Render them into Release History through the same marker-keyed span
mechanism the support matrix uses, with the same fail-closed behavior:
markers absent means the generator errors rather than appending, so
placement stays under human control.

Rows come from RELEASE_STATS rather than a fixed v1.0.0-v1.3.0 list, so
a new release added by the per-release bump checklist shows up with no
edit here. Both the visible table and the agent mirror now build from
one release_stats_table helper, so they cannot drift apart -- the
regenerated releases-data.mdx is byte-identical, confirming the
extraction changed no output.

Four rows on a short page, so a plain table rather than an accordion.

Signed-off-by: Dan Gil <dagil@nvidia.com>
The "coming from" picker treated a RELEASE_STATS entry as proof that a
release has per-release Deprecations and Known Issues sections to link
to. That held only because RELEASE_STATS covered exactly the four v1.x
stables. Gate on notesHref, which is the actual signal for a docs-native
release page, so RELEASE_STATS can carry releases that are counted on
Release History but have no sections to deep-link.

Signed-off-by: Dan Gil <dagil@nvidia.com>
The table rendered four rows because RELEASE_STATS held four entries,
not because the older releases lacked data. Backfill v0.9.0 through
v0.6.0 from their GitHub bodies and record the counting rules alongside
the data so later ingestions stay comparable across the two release-note
eras.

Pre-v1.0.0 bodies state no PR or contributor totals, so those cells stay
absent and render as dashes; their first-timer lists are counted, and
v0.9.0's lone Deprecation Notices entry is the same entry class the v1.x
rows count under Breaking Changes. The two gaps in the existing rows are
genuine: v1.0.0 states commits rather than PRs, and v1.2.0 names no
first-time contributors at all.

Signed-off-by: Dan Gil <dagil@nvidia.com>
Second pass at the empty prs and contributors cells, this time against the
TPM release archive rather than the GitHub bodies alone. The archive
corroborates the first-timer figures already published for v0.8.0 and
v0.9.0 but supplies no usable PR or contributor total: its own numbers
disagree with each other, and the one figure it states for v1.0.0 is a
commit count that a later document reuses as a merged-PR denominator.

Deriving the counts from git does not rescue it either. The closest
tag-to-tag method returns 910/572/899 where the release bodies state
930/603/896 — wrong in both directions, so it is not a window offset that
could be corrected for. Filling the older rows with it would put a
different unit in the same column.

Record all of that next to the data so the next pass starts from the
evidence instead of repeating the search.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia force-pushed the dagil-nvidia/release-stats-on-history branch from 5d8fb95 to 603c04e Compare July 29, 2026 15:44
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 603c04e

Propagate #12215's main merge (0a01ca7) into #12223.

Resolve conflict in docs/fern/scripts/gen_llms_tables.py PAGES dict:
- Keep #12215's rename releases-data.mdx -> releases-machine-readable.mdx.
- Preserve #12223's release-stats block, but relocate its page target from
  the legacy release-notes/README.mdx path to the current
  releases/release-history.mdx path so the release-stats:begin/end markers
  in the live Release History page continue to be updated.

Signed-off-by: Daniel Gil <dagil@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 31, 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.

dagil-nvidia added a commit that referenced this pull request Jul 31, 2026
Propagate #12223's updated parent (707fac7, which itself carries #12215's
merge of main and the releases-machine-readable.mdx rename) into #12241.

Resolve conflict in docs/fern/pages/developer-guide/knowledge-base/
modular-components/backends/sglang/overview.md Note 1: keep this PR's
corrected SGLang KV-routing text (hash-forwarding patch on Dynamo's image,
fallback to text-prefix on custom builds) and update its `Source` href to
the current relocated site path use-cases/multimodal-serving/
multimodal-kv-routing.md (matching notes 2/3 already using the relocated
knowledge-base paths). The compatibility.mdx SGLang cell auto-merged with
the same correction; the driver-floor renderer/table and generator tests
carry over untouched at their current paths.

Signed-off-by: Daniel Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia merged commit 9934563 into dagil-nvidia/compatibility-page-cleanup Jul 31, 2026
20 checks passed
@dagil-nvidia
dagil-nvidia deleted the dagil-nvidia/release-stats-on-history branch July 31, 2026 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant