docs-version-sync: cannot resolve the repo root on the public mirror

Open Beginner friendly
#549 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
84/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
go
Domain
cli, tooling

Research direction

Read tools/docs-version-sync/main.go and compare its findRepoRoot logic with tools/collect-dependencies/main.go, then run the documented command from docs/AGENTS.md on the public mirror. Update the root detection and the relevant AGENTS guidance so the command works without imports.yaml; done means the command runs successfully from the mirror.

Written by the indexing model from the issue text.

Description

Describe the bug

The regeneration command documented in docs/AGENTS.md cannot run in this
repository:

$ go run -C tools/docs-version-sync . --target main
docs-version-sync: imports.yaml not found (started from .../tools/docs-version-sync)
exit status 1

findRepoRoot in tools/docs-version-sync/main.go walks up looking only for
imports.yaml, which is intentionally absent on the public mirror. The repo
states this in three places: license-compliance.md:232,
tools/collect-dependencies/scan.go:31, and
tools/collect-dependencies/README.md:38.

The sibling tool tools/collect-dependencies/main.go already handles it by
falling back to the .git marker.

Root AGENTS.md also points agents at imports.yaml without noting that it is
internal, unlike tools/ci/subproject-validations.yaml, which is marked as not
present in this public snapshot.

Steps or code to reproduce bug

go run -C tools/docs-version-sync . --target main

Expected behavior

The documented command runs. Mirror the .git fallback that
collect-dependencies already uses.

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.