Skip to content

docs: fix stale catalog links after samples rename - #259

Open
rollandf wants to merge 1 commit into
run-ai:mainfrom
rollandf:fix-links
Open

docs: fix stale catalog links after samples rename#259
rollandf wants to merge 1 commit into
run-ai:mainfrom
rollandf:fix-links

Conversation

@rollandf

@rollandf rollandf commented Aug 24, 2026

Copy link
Copy Markdown

What does this PR do?

fix stale catalog links after samples rename

Checklist

  • All commits are signed off with DCO (git commit -s)
  • New/modified files have SPDX license and copyright headers
  • Documentation updated (if applicable)
  • Tests pass (make check)
  • No proprietary or internal information included

Summary by CodeRabbit

  • Documentation
    • Updated the LeaderWorkerSet example link to the current catalog location.
    • Refreshed pattern quick-reference links for transformer, pod specification, conditions, phase, per-instance, and replica identity examples.
    • Added Roadmap and Changelog links to the Documentation section.

@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 7a2405f4-13d8-4871-8eb4-68d79a31aa3b

📥 Commits

Reviewing files that changed from the base of the PR and between 2a842a5 and 339c00b.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

Documentation links now use current docs/catalog/ paths. The README also links to the Roadmap and Changelog.

Changes

Documentation path updates

Layer / File(s) Summary
Update documentation references
README.md, skills/add-workload-type/reference/sample-index.md
Updated LeaderWorkerSet and workload pattern references to current catalog paths. Added Roadmap and Changelog links to the Documentation section.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 339c0

This update refreshes documentation catalog paths and adds Roadmap and Changelog links. No concrete unresolved merge risk is identified.

Poem

A rabbit checks each catalog trail,
And sees the newest links prevail.
Roadmap and Changelog join the view,
Sample paths point to catalogs true.
“Hop!” says Bun, “The docs are new!”

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating stale catalog links after the samples rename.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment thread docs/assets/lws-workload-tree.svg

@yuval-gr yuval-gr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

@yuval-gr

yuval-gr commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

@rollandf please sign your commits so we can merge this.

Signed-off-by: Fred Rolland <frolland@nvidia.com>
@rollandf

rollandf commented Sep 7, 2026

Copy link
Copy Markdown
Author

@rollandf please sign your commits so we can merge this.

Hey, the commit is signed already

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.

2 participants