Skip to content

docs: clean README main-branch references for r26.07 - #8904

Merged
mc-nv merged 1 commit into
r26.07from
mchornyi/TRI-1594/before-ngc-release-update-release-docs
Jul 24, 2026
Merged

docs: clean README main-branch references for r26.07#8904
mc-nv merged 1 commit into
r26.07from
mchornyi/TRI-1594/before-ngc-release-update-release-docs

Conversation

@mc-nv

@mc-nv mc-nv commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

What does the PR do?

Converts the 9 remaining GitHub documentation links in the top-level README.md from the main branch to the r26.07 release branch, so the release-branch README points readers at release-branch docs.

Links updated (/blob/main//blob/r26.07/, /tree/main//tree/r26.07/):

  • backend/docs/python_based_backends.md
  • backend/docs/backend_platform_support_matrix.md
  • backend/README.md
  • perf_analyzer/README.md
  • client/src/c++/examples, src/python/examples, src/java/.../examples
  • server/docs/protocol/extension_binary_data.md
  • python_backend/inferentia

All target paths were verified to exist on each repo's r26.07 branch. The Java source-path segment src/main/java/... is intentionally left unchanged (it is a source directory, not a branch ref). The git clone -b r26.07 line and the LATEST RELEASE/main disclaimer were already handled at code-freeze.

Checklist

  • PR title reflects the change and is of format <commit_type>: <Title>
  • Changes are described in the pull request.
  • Related issues are referenced.
  • Populated github labels field
  • Added test plan and verified test passes.
  • Verified that the PR passes existing CI.
  • Verified copyright is correct on all changed files.
  • Added succinct git squash message before merging ref.
  • All template sections are filled out.
  • Optional: Additional screenshots for behavior/output changes with before/after.

Commit Type:

Check the conventional commit type
box here and add the label to the github PR.

  • build
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

Related PRs:

None — single-repo change (server).

Where should the reviewer start?

README.md — the 9 documentation links converted from main to r26.07.

Test plan:

Docs-only change; no functional tests. Verify each converted link resolves on GitHub against the r26.07 branch.

  • CI Pipeline ID: N/A (docs-only; no build pipeline)

Caveats:

Sibling-repo links (backend, perf_analyzer, client, python_backend) are now pinned to r26.07. Prior releases (r26.04–r26.06) left these on main; pinning them here is intentional per TRI-1594's "clean any remaining main-branch references."

Background

Part of the "Update release docs" step in the Before-NGC-Release checklist — the release-branch README should not point readers at main-branch documentation.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Resolves: TRI-1594

@greptile-apps

greptile-apps Bot commented Jul 24, 2026

Copy link
Copy Markdown

Greptile Summary

This PR updates README.md to replace nine GitHub deep-links that pointed to the main branch with the r26.07 release-branch equivalents, aligning the documentation with the release branch it lives on.

  • Links to backend, perf_analyzer, client, and python_backend repos are updated from blob/main / tree/main to blob/r26.07 / tree/r26.07.
  • The self-referential link to server/blob/main/docs/protocol/extension_binary_data.md is also updated to r26.07.
  • No blob/main or tree/main references remain in the file (the only /main/ still present is the Java package path src/main/java, which is not a branch reference).

Confidence Score: 5/5

Safe to merge — purely mechanical link updates with no logic, no code, and no configuration changes.

Every changed line is a URL swap from main to r26.07 in documentation text. No blob/main or tree/main references remain after the change, and the only /main/ left in the file is a Java source directory path, not a branch reference. Nothing here can break runtime behavior.

No files require special attention.

Important Files Changed

Filename Overview
README.md Nine external GitHub deep-links updated from main to r26.07; no remaining branch-pinned main references and no logic changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md on r26.07 branch] --> B{External GitHub link}
    B -->|backend repo| C[blob/r26.07/docs/python_based_backends.md]
    B -->|backend repo| D[blob/r26.07/docs/backend_platform_support_matrix.md]
    B -->|backend repo| E[blob/r26.07/README.md]
    B -->|perf_analyzer repo| F[blob/r26.07/README.md]
    B -->|client repo| G[blob/r26.07/src/c++/examples]
    B -->|client repo| H[blob/r26.07/src/python/examples]
    B -->|client repo| I[blob/r26.07/src/java/.../examples]
    B -->|server repo| J[blob/r26.07/docs/protocol/extension_binary_data.md]
    B -->|python_backend repo| K[tree/r26.07/inferentia]
Loading

Reviews (1): Last reviewed commit: "docs: clean README main-branch reference..." | Re-trigger Greptile

@mc-nv mc-nv added the Documentation Improvements or additions to documentation (docs: PRs) label Jul 24, 2026
@mc-nv mc-nv self-assigned this Jul 24, 2026
@mc-nv
mc-nv merged commit 5ebb76d into r26.07 Jul 24, 2026
4 checks passed
@mc-nv
mc-nv deleted the mchornyi/TRI-1594/before-ngc-release-update-release-docs branch July 24, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation (docs: PRs)

Development

Successfully merging this pull request may close these issues.

3 participants