Skip to content

skills: rename resources/ to references/#1283

Open
rgsl888prabhu wants to merge 4 commits into
release/26.06from
skill-rename-resources-to-references
Open

skills: rename resources/ to references/#1283
rgsl888prabhu wants to merge 4 commits into
release/26.06from
skill-rename-resources-to-references

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

Align skill subfolder name with the agentskills.io standard. Pure rename — no content changes.

Mirrors #1242 (head branch moved from fork into NVIDIA/cuopt).

rgsl888prabhu and others added 4 commits May 19, 2026 10:26
Align with the agentskills.io standard folder name. No content changes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
@rgsl888prabhu rgsl888prabhu requested review from a team as code owners May 21, 2026 22:51
@rgsl888prabhu rgsl888prabhu requested a review from tmckayus May 21, 2026 22:51
@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/nvskills-ci

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 100d89bc-1482-43d2-9a1b-5cf757fc0c2b

📥 Commits

Reviewing files that changed from the base of the PR and between f173aa2 and 667f3b1.

📒 Files selected for processing (27)
  • .github/workflows/pr.yaml
  • skills/cuopt-developer/SKILL.md
  • skills/cuopt-developer/evals/evals.json
  • skills/cuopt-developer/references/build_and_test.md
  • skills/cuopt-developer/references/contributing.md
  • skills/cuopt-developer/references/conventions.md
  • skills/cuopt-developer/references/first_time_setup.md
  • skills/cuopt-developer/references/python_bindings.md
  • skills/cuopt-developer/references/troubleshooting.md
  • skills/cuopt-install/SKILL.md
  • skills/cuopt-install/references/verification_examples.md
  • skills/cuopt-numerical-optimization-api-c/SKILL.md
  • skills/cuopt-numerical-optimization-api-c/assets/lp_basic/README.md
  • skills/cuopt-numerical-optimization-api-c/assets/lp_duals/README.md
  • skills/cuopt-numerical-optimization-api-c/assets/milp_basic/README.md
  • skills/cuopt-numerical-optimization-api-c/assets/milp_production_planning/README.md
  • skills/cuopt-numerical-optimization-api-c/assets/mps_solver/README.md
  • skills/cuopt-numerical-optimization-api-c/references/examples.md
  • skills/cuopt-numerical-optimization-api-python/SKILL.md
  • skills/cuopt-numerical-optimization-api-python/assets/README.md
  • skills/cuopt-numerical-optimization-api-python/references/qp_examples.md
  • skills/cuopt-routing-api-python/SKILL.md
  • skills/cuopt-routing-api-python/assets/README.md
  • skills/cuopt-routing-api-python/assets/pdp_basic/README.md
  • skills/cuopt-routing-api-python/assets/vrp_basic/README.md
  • skills/cuopt-routing-api-python/references/examples.md
  • skills/cuopt-routing-api-python/references/server_examples.md

📝 Walkthrough

Walkthrough

This PR systematically updates documentation cross-references across the cuopt repository, relocating all links from resources/ paths to references/ paths. The changes span workflow configuration, skill metadata files, evaluation entries, and example documentation, ensuring consistent documentation organization.

Changes

Documentation Path Reorganization

Layer / File(s) Summary
Workflow test exclusion patterns
.github/workflows/pr.yaml
Updated excluded glob patterns in test_cpp, test_python_conda, and test_python_wheels file groups from !skills/**/resources/** to !skills/**/references/** to align test automation with the reorganized documentation structure.
Developer skill documentation migration
skills/cuopt-developer/SKILL.md, skills/cuopt-developer/evals/evals.json
Updated links in SKILL.md for first-time setup, build/test guidance, Python bindings architecture, and contribution workflows; updated corresponding eval entries (dev-013, dev-023, dev-031, inst-001, inst-008) to reference paths under references/ instead of resources/.
Installation skill documentation migration
skills/cuopt-install/SKILL.md
Updated the verification examples reference link to point to references/verification_examples.md.
Numerical Optimization C API documentation migration
skills/cuopt-numerical-optimization-api-c/SKILL.md, skills/cuopt-numerical-optimization-api-c/assets/*/README.md
Updated SKILL.md and example asset READMEs (lp_basic, lp_duals, milp_basic, milp_production_planning, mps_solver) to reference references/examples.md for API parameters and example guidance.
Numerical Optimization Python API documentation migration
skills/cuopt-numerical-optimization-api-python/SKILL.md, skills/cuopt-numerical-optimization-api-python/assets/README.md
Updated SKILL.md and assets README to reference references/qp_examples.md for QP-specific examples and guidance.
Routing API Python documentation migration
skills/cuopt-routing-api-python/SKILL.md, skills/cuopt-routing-api-python/assets/*/README.md
Updated SKILL.md to reference references/examples.md and references/server_examples.md; updated asset READMEs (main assets, pdp_basic, vrp_basic) to reference references/examples.md for example patterns.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested labels

non-breaking, improvement

Suggested reviewers

  • tmckayus
  • Iroy30
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'skills: rename resources/ to references/' is specific and clearly describes the main change—a systematic folder rename across skills to align with agentskills.io standards.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale (alignment with agentskills.io standard), the nature of the change (pure rename with no content modifications), and its relationship to a prior PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch skill-rename-resources-to-references

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

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.

1 participant