docs: version catalog is stale relative to the generated manifest

Open Beginner friendly
#552 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
documentation

Research direction

Start with docs/version-catalog/main.yaml and compare it with the generated block in docs/user/manifest.md. After #549 is applied, run go run -C tools/docs-version-sync . --target main and use the authoritative artifact manifest to update the catalog. Done means regeneration produces no diff against the committed manifest.

Written by the indexing model from the issue text.

Description

Describe the bug

docs/user/manifest.md is ahead of its generator input,
docs/version-catalog/main.yaml. Regenerating the manifest reverts real content:

-| `helm-nvcf-ui` | `1.1.2` | Optional | ... |
-| `nvcf-gateway-routes` | `1.15.0` | ... |
+| `nvcf-gateway-routes` | `1.14.0` | ... |

The manifest was last updated on 2026-07-25 by #436
(feat(self-managed): bump nvcf-ui charts). The catalog was last updated on
2026-07-23 and still lists nvcf-gateway-routes 1.14.0 with no helm-nvcf-ui
entry.

docs/AGENTS.md says not to hand-edit the generated manifest block and to
regenerate it with go run -C tools/docs-version-sync . --target main. That
command has never worked in this repository (see #549), which is the likely
reason the manifest drifted from the catalog.

Steps or code to reproduce bug

With the fix from #549 applied:

go run -C tools/docs-version-sync . --target main
git diff docs/user/manifest.md

Expected behavior

Refresh docs/version-catalog/main.yaml from the authoritative artifact
manifest so regeneration is a no-op against the committed manifest. Needs the
real published versions, so no Pull Request is attached.

Dominant language
Go
Stars
218
Forks
72
Avg merge
1d 8h
Merged PRs (30d)
415

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NVIDIA/nvcf

All issues in NVIDIA/nvcf

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.