Skip to content

[codex] docs: finish infra-controller rename accuracy pass#3097

Draft
kfelternv wants to merge 2 commits into
NVIDIA:mainfrom
kfelternv:codex/issue-2358-doc-accuracy
Draft

[codex] docs: finish infra-controller rename accuracy pass#3097
kfelternv wants to merge 2 commits into
NVIDIA:mainfrom
kfelternv:codex/issue-2358-doc-accuracy

Conversation

@kfelternv

@kfelternv kfelternv commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • align the Quick Start environment requirements, setup options, phase table, and deployed-component list with helm-prereqs/setup.sh
  • migrate all 27 legacy changelog API links to 17 verified routes in the current NVIDIA REST API reference
  • describe the kustomize NICO_TAG path accurately as the NICo Core (nico-core) image and remove the remaining nvmetal-nico Markdown references
  • fix the malformed auth link and three adjacent broken relative documentation links
  • update the in-script Phase 7 summary with NICo Flow and the REST site-agent

Why

The repository rename work in #2357 fixed part of the documentation, but later setup changes left the operator path inconsistent. The Quick Start stopped at Phase 7h without documenting Flow, the site-agent, the current setup flags, or the actual conditional environment requirements. Historical changelog links also continued to point to the old GitHub Pages reference.

This change synchronizes the operator documentation with the current scripts and maps each old API link to its specific maintained destination.

Related issues

Closes #2358

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Verified against upstream main at 8dc207ab25d8aec3001449ab1b5ea440977f05f0:

  • git diff --check — pass
  • bash -n helm-prereqs/setup.sh — pass
  • make -n images-core IMAGE_REGISTRY=registry.example/nico IMAGE_TAG=verify VERSION=verify CI_COMMIT_SHORT_SHA=verify — continues to emit the deliberately renamed local image registry.example/nico/nico:verify
  • deploy/kustomization.yaml maps the Core placeholder to NICO_REGISTRY_PATH/nico-core with NICO_TAG, matching the updated README wording
  • every supported long setup option appears in both setup.sh and the Quick Start
  • stale-string assertions find zero legacy API URLs, infra-controller-core prose, malformed auth URLs, or nvmetal-nico Markdown references
  • all 17 unique changelog destinations are present in NVIDIA's live llms.txt index and return HTTP 200; the corrected auth URL also returns HTTP 200
  • repository rumdl diagnostics across the four primary issue files decrease from 32 on main to 27; no new diagnostics occur on edited lines

Additional Notes

  • Image names belong to distinct paths and are intentionally not collapsed here: local make images produces nico, kustomize uses nico-core, and the currently published Helm/setup artifact remains nvmetal-carbide.
  • Changelog release descriptions remain historical, while their API-reference links now point to the maintained documentation.
  • Existing runtime identifiers such as the ncx-service Keycloak client and /org/ncx/ API examples were intentionally preserved because they still match the implementation.
  • This is a draft fork PR; upstream CI may require the repository's normal /ok-to-test copy workflow before checks run.

@copy-pr-bot

copy-pr-bot Bot commented Jul 2, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9bb0559b-701d-4919-88d3-c8d69e102dd2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Finish infra-controller rename: quick-start accuracy refresh + remaining markdown files

1 participant