Skip to content

docs(skill): clarify runtime resource load paths - #3106

Draft
luzhuang wants to merge 1 commit into
dev/2.0from
codex/issue-3104-resource-load-contract
Draft

docs(skill): clarify runtime resource load paths#3106
luzhuang wants to merge 1 commit into
dev/2.0from
codex/issue-3104-resource-load-contract

Conversation

@luzhuang

@luzhuang luzhuang commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • route runtime resource-loading questions to the existing resource ownership reference
  • document that resourceManager.load() accepts browser URLs or exact registered virtualPath values, not host filesystem paths
  • keep the runtime API and Skill reference structure unchanged

Validation

  • traced ResourceManager.load() through virtual-path resolution and browser XMLHttpRequest
  • git diff --check

Closes #3104

Summary by CodeRabbit

  • Documentation
    • Expanded resource ownership guidance to cover runtime resource loading.
    • Documented supported resource paths, including browser URLs and registered virtual paths.
    • Clarified that host filesystem paths are not supported.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Team

Run ID: a630aef6-a49d-4c52-894c-bfe96ae4c32e

📥 Commits

Reviewing files that changed from the base of the PR and between 1d06406 and 4a01106.

📒 Files selected for processing (2)
  • packages/galacean/skills/engine-knowledge/SKILL.md
  • packages/galacean/skills/engine-knowledge/references/resource-ownership.md

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


Walkthrough

The engine knowledge skill now documents that ResourceManager.load() accepts browser URLs or exact registered virtual paths. It also states that the runtime loader does not read host filesystem paths.

Changes

Runtime resource loading documentation

Layer / File(s) Summary
Resource loading contract
packages/galacean/skills/engine-knowledge/references/resource-ownership.md, packages/galacean/skills/engine-knowledge/SKILL.md
The resource ownership reference documents runtime URL and exact virtualPath loading. The routing entry includes runtime resource loading.

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

Merge Risk: ⚪ Minimal · up to 4a011

This documentation-only change clarifies supported runtime resource paths without changing the runtime API, so no actionable merge-blocking risk remains.

Poem

A rabbit reads the loading guide,
URLs and paths now hop inside.
Host files stay beyond the gate,
Exact virtual paths locate.
The skill blooms clear and bright.

🚥 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 summarizes the documentation change to clarify runtime resource load paths.
Linked Issues check ✅ Passed The changes satisfy issue #3104 by documenting browser URLs, exact registered virtualPath values, and the host-filesystem boundary. The routing entry also includes runtime resource loading, with no ru…
Out of Scope Changes check ✅ Passed The changes are limited to the existing engine-knowledge documentation and directly support the linked issue objectives. No unrelated code or API changes are present.
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…
Full details: Linked Issues check

Explanation

The changes satisfy issue #3104 by documenting browser URLs, exact registered virtualPath values, and the host-filesystem boundary. The routing entry also includes runtime resource loading, with no runtime API or new reference changes.

Full details: Docstring Coverage

Explanation

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 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/issue-3104-resource-load-contract

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@luzhuang
luzhuang marked this pull request as draft September 1, 2026 07:43
@codecov

codecov Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.76%. Comparing base (1d06406) to head (4a01106).

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/2.0    #3106      +/-   ##
===========================================
- Coverage    85.94%   85.76%   -0.19%     
===========================================
  Files          811      811              
  Lines        94826    94749      -77     
  Branches     11620    11628       +8     
===========================================
- Hits         81497    81259     -238     
- Misses       13239    13398     +159     
- Partials        90       92       +2     
Flag Coverage Δ
unittests 85.76% <ø> (-0.19%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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