Skip to content

[Docs epic] Close post-v1.2.0 documentation gaps for 26.07 #2118

Description

@lbliii

Goal

Close every actionable documentation gap introduced after NeMo Curator v1.2.0, and make the next release's docs/release notes complete enough for users to adopt new features and migrate breaking behavior.

Audit boundary and method

  • Primary boundary: commits reachable from main but absent from the v1.2.0 tag, reviewed through PR #2116 (merged 2026-06-29 19:34:32 UTC)
  • Original inventory: 67 PRs merged after the v1.2.0 publication timestamp
  • Supplemental code-freeze audit: 22 additional release-relevant PRs identified by Sara that merged after the 26.04 code freeze but before the release publication timestamp
  • Evidence reviewed: PR titles/bodies, changed file paths, git v1.2.0..main, and the current fern/versions/main/pages/ documentation tree
  • Decision rule: create focused docs work for user-facing features, public API/configuration changes, behavior changes, and migration hazards; bundle smaller release-note and reference gaps instead of creating noise

The publication timestamp alone was insufficient: it omitted release-relevant commits that missed v1.2.0 despite merging before the release was published. The supplemental disposition is tracked in #2144, #2145, and #2146.

Planned documentation workstreams

Child issues are linked above for traceability.

Complete PR disposition

Dedicated docs workstreams required (18)

These PRs add or change user-facing workflows/APIs and need more than a release-note bullet:

#1727, #1835, #1863, #1898, #1899, #1980, #2033, #2036, #2038, #2045, #2054, #2058, #2062, #2070, #2072, #2077, #2086, #2110

Release-notes or migration coverage required (8)

These are smaller fixes, platform constraints, or already-partially-documented removals. They belong in the release/migration task rather than separate feature pages:

#2024, #2049, #2053, #2055, #2057, #2104, #2107, #2109

Documentation already landed; verify in release sweep (9)

No standalone follow-up is currently justified, but the release-notes owner should verify navigation, versioning, and consistency:

#1983, #1961, #1991, #2000, #2029, #2030, #2071, #2096, #2114

No public docs change required (32)

Dependency/security lockfile updates, CI/release plumbing, test-only changes, and internal benchmark-harness maintenance:

#1966, #2001, #2002, #2009, #2021, #2022, #2026, #2032, #2035, #2039, #2041, #2043, #2046, #2047, #2048, #2068, #2079, #2081, #2082, #2083, #2084, #2085, #2087, #2088, #2091, #2099, #2100, #2103, #2105, #2108, #2115, #2116

Supplemental code-freeze disposition

Sara's follow-up list added 22 release-relevant PRs that were outside the original publication-time query.

New dedicated or bundled workstreams

Added to existing workstreams

Bundled release-note coverage (#2144 and #2120)

#1746, #1762, #1763, #1774, #1870, #1880, #1888, #1890

Epic-level acceptance criteria

  • Every PR in the dedicated and release-only buckets is covered by a child issue or an explicit release-note entry
  • fern/versions/main/pages/about/release-notes/index.mdx describes 26.07 rather than 26.04
  • Breaking changes and removed/renamed options have migration instructions
  • New pages are included in Fern navigation and pass docs validation
  • Code samples match the merged APIs and avoid user-supplied task_id
  • Links between concept, tutorial, API-reference, and release-note pages are complete
  • Each child issue records the PRs it closes documentation coverage for

Out of scope

  • Re-documenting internal benchmark infrastructure
  • Adding public docs for dependency-only or CI-only changes
  • Backporting new 26.07 feature docs into frozen v26.04 pages unless a correction is required

Activity

  1. self-assigned this
    on Jun 29, 2026
  2. sarahyurick commented on Jun 29, 2026

    @sarahyurick
    Contributor

    FWIW, here is a full list of PRs merged after code freeze and not included in the 26.04 release. I excluded PRs that were just docs updates, minor dependency bumps and/or GitHub CI updates, benchmarking updates, or very minor PRs acting as follow-ups to major PRs:

    Listed in the order the PRs were merged.

  3. lbliii commented on Jul 1, 2026

    @lbliii
    ContributorAuthor

    Supplemental workstream PR mapping is now complete:

    All four branches pass fern check with 0 errors. #2143 has also been corrected for #2063 now being on main, so the release documentation no longer says resumability is excluded.

  4. sarahyurick commented on Jul 1, 2026

    @sarahyurick
    Contributor

    Not sure if this is already being tracked somewhere but the last 2 PRs to make it before code freeze were:

    so those should be ready for documentation as well.

  5. lbliii commented on Jul 1, 2026

    @lbliii
    ContributorAuthor

    Disposition for Sarah latest code-freeze addendum is implemented:

    Validation: #2134 and #2154 both pass fern check with 0 errors. #2154 also validates all 10 shell examples with bash -n and documents every backend SLURM-array environment variable.

  6. lbliii commented on Jul 2, 2026

    @lbliii
    ContributorAuthor

    Adversarial review follow-ups are now tracked as sub-issues of this epic:

    Before the 26.06 docs publication

    Non-blocking post-release IA

    PR #2143 was updated directly in commit 86e286845 with the two missing release-critical migrations: the removed qwen video caption variant and the removed InferenceModelConfig API. It now also carries the corresponding Qwen/Nemotron and typed Ray Serve/Dynamo release-note entries.

    Recommended timing: merge detailed feature PRs first; complete #2161 and #2162 before the documentation publication tag; use #2160 as the final integration gate; address #2159 after release unless a smaller split becomes necessary while resolving another issue. Merging to main does not publish the site, so there is room to reconcile the combined tree before an explicitly authorized docs/v* tag.

  7. m13v commented on Jul 3, 2026

    @m13v

    the part that bites in an audit this size is the per-PR triage. scoring each of the 67 in isolation into dedicated-docs vs release-note-bullet vs no-docs surfaces whatever cleared the bar on its own day, but a behavior that drifted a little across a dozen small PRs, none individually docs-worthy, gets bundled into one bullet and its cumulative migration hazard never gets measured. the slow-accumulation change is usually the exact one that reads as breaking to a user, and it's the one the per-item score quietly drops.

  8. lbliii commented on Jul 7, 2026

    @lbliii
    ContributorAuthor

    Added supplemental workstream for arm64 audio platform constraints:

    Trigger: nvbugs 6400678 / 6409435 / 6409439 thread (2026-07-07). Audio missing packages on arm64 are expected; Dong Hyuk confirmed docs should reflect this. Sarah requested tutorial/docs updates and nvbug responses (assigned to Aaftab V in Slack).

    Disposition: Separate child issue rather than bundling into #2162 (API/example repair) or #2144 (late-freeze release notes). Coordinate with #2162 to avoid conflicting audio-page edits. The datasets/dedup portion of the thread stays with #2164.

    Suggested timing: Before 26.06 docs publication, alongside or immediately after #2162.

  9. changed the title [-][Docs epic] Close post-v1.2.0 documentation gaps for 26.06[/-] [+][Docs epic] Close post-v1.2.0 documentation gaps for 26.07[/+] on Jul 22, 2026
  10. lbliii commented on Jul 22, 2026

    @lbliii
    ContributorAuthor

    Tracker naming update: The docs GA train for this epic is 26.07, not 26.06. 26.07 is not hard-coded in Fern until the GA snapshot (main/ → v26.07/) lands in #2160.

    Updated in this pass:

    Still to do at GA cut (not in tracker yet): create fern/versions/v26.07/, retarget latest.yml, and update fern/docs.yml redirects/version picker. The unmerged release-notes branch still uses 26.06 filenames/text and should be renamed to 26.07 before merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationroadmap

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions