Skip to content

Remove stale execute_code guide fallbacks#67

Merged
Ker102 merged 2 commits into
mainfrom
feature/direct-tool-guide-cleanup-2
May 17, 2026
Merged

Remove stale execute_code guide fallbacks#67
Ker102 merged 2 commits into
mainfrom
feature/direct-tool-guide-cleanup-2

Conversation

@Ker102
Copy link
Copy Markdown
Owner

@Ker102 Ker102 commented May 17, 2026

Summary

  • route architectural glass guidance through create_material_preset and inspect_material_node_graph
  • update local asset, assembly, and aesthetic guides to prefer direct tools before execute_code fallbacks
  • add secondary regression coverage for stale execute_code-first guide phrases

Tests

  • npx tsx scripts/test/test-direct-tool-guide-cleanup-secondary.ts
  • npx tsx scripts/test/test-direct-tool-guide-cleanup.ts
  • npx tsx scripts/test/test-blender-rag-skill-migration.ts
  • npx tsc --noEmit --incremental false
  • npm run lint

Note: lint still emits the existing baseline-browser-mapping freshness warning.

Summary by CodeRabbit

  • Documentation
    • Prioritized using direct Blender tools first; narrowed when code execution is appropriate and added explicit guidance on tool categories and decomposing decorative parts.
    • Replaced inline glass-material steps with a preset+inspection workflow for material assignment and verification.
    • Clarified parenting, hierarchy, layout, and hybrid workflow recommendations.
  • Tests
    • Added verification tests to ensure guide wording and tool-vs-code guidance remain consistent.

Review Change Stack

@github-actions github-actions Bot added documentation Improvements or additions to documentation scripts labels May 17, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 17, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: dd26d8fe-2f85-4b2b-9ebb-e521e2f51199

📥 Commits

Reviewing files that changed from the base of the PR and between 9dcc065 and 92329f9.

📒 Files selected for processing (3)
  • data/tool-guides/aesthetic-quality-guide.md
  • data/tool-guides/object-assembly-guide.md
  • scripts/test/test-direct-tool-guide-cleanup-secondary.ts

📝 Walkthrough

Walkthrough

This PR updates four tool-guide documents to prefer direct Blender tools for standard tasks and narrows execute_code to complex/custom or procedural geometry cases. It also adds a TypeScript test that validates the presence and absence of specific direct-tools vs execute_code wording across the updated guides.

Changes

Direct Tools Guidance Updates

Layer / File(s) Summary
Updated tool preference guidance across guides
data/tool-guides/aesthetic-quality-guide.md, data/tool-guides/architectural-completeness-guide.md, data/tool-guides/local-asset-guide.md, data/tool-guides/object-assembly-guide.md
Aesthetic-quality: metadata and guidance rewritten to prefer direct tools and restrict execute_code to irregular/organic shapes, multi-part assemblies, vertex/edge/detail edits, and array/curve-driven repeats. Architectural-completeness: replaced inline EEVEE glass node setup with create_material_preset("glass", object_name="Window_Glass") + inspect_material_node_graph to verify Transmission Weight and IOR. Local-asset: refines hybrid workflow, reserving execute_code for unsupported custom hero/procedural forms and directing room layout, cameras, lights, transforms, and render setup to direct tools. Object-assembly: removes hand-written parenting example in favor of parent_set and organize_collection_hierarchy, noting these preserve world transforms; narrows execute_code to procedural root-helper generation scenarios.
Test validation for direct-tools guidance
scripts/test/test-direct-tool-guide-cleanup-secondary.ts
New TypeScript test reads the four markdown guides and runs regex-based assertions to confirm expected direct-tools phrasing and the restricted use of execute_code, logging a success message on pass.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • Ker102/ViperMesh#64: Similar updates enforcing direct Blender tools vs execute_code phrasing and adding tests to validate guidance consistency.
  • Ker102/ViperMesh#41: Introduced material preset/inspection tooling referenced by the architectural-completeness guide changes.

Suggested labels

documentation, desktop, scripts

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description provides a clear summary and lists comprehensive tests, but does not follow the required template structure with sections like Type of Change, Motivation and Context, or the Checklist. Restructure the description to follow the template, including Type of Change (Documentation update), Motivation and Context explaining why guide updates were needed, How This Has Been Tested section, and a completed Checklist.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Remove stale execute_code guide fallbacks' accurately summarizes the main change: updating documentation to remove outdated guidance that prioritized execute_code over direct tools.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/direct-tool-guide-cleanup-2

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 and usage tips.

@coderabbitai coderabbitai Bot added the desktop label May 17, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@data/tool-guides/aesthetic-quality-guide.md`:
- Around line 38-39: The heading "### When to Use Direct Tools First" is
immediately followed by body text; insert a single blank line after that heading
so the heading is separated from the paragraph (satisfy MD022). Locate the
heading string "### When to Use Direct Tools First" and add one empty line
before the sentence "Use direct tools first for repeatable operations:..." to
ensure proper Markdown linting.

In `@data/tool-guides/object-assembly-guide.md`:
- Around line 214-215: Update the guidance to remove the outdated
execute_code-era instructions about manually handling matrix_parent_inverse:
make a single consistent statement that parent_set and
organize_collection_hierarchy preserve world transforms so child objects won't
visually jump when parented, and that execute_code should only be recommended
when the root helper object must be procedurally generated and no direct
creation tool covers it; specifically eliminate or reword the
matrix_parent_inverse handling reference and ensure the doc mentions parent_set,
organize_collection_hierarchy, and execute_code by name so there is no
contradiction.

In `@scripts/test/test-direct-tool-guide-cleanup-secondary.ts`:
- Around line 18-22: The tests currently check that execute_code-era parenting
strings are gone from guides.objectAssembly but miss a regression check for
stale "matrix_parent_inverse" guidance; update the test near the existing
assertions (which use assert.doesNotMatch and assert.match against
guides.objectAssembly) to add a negative assertion that the guide does not
contain /matrix_parent_inverse/ so the cleanup is enforced.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 198b9343-570f-4dc3-8a02-eba21a47ad1e

📥 Commits

Reviewing files that changed from the base of the PR and between d062908 and 9dcc065.

📒 Files selected for processing (5)
  • data/tool-guides/aesthetic-quality-guide.md
  • data/tool-guides/architectural-completeness-guide.md
  • data/tool-guides/local-asset-guide.md
  • data/tool-guides/object-assembly-guide.md
  • scripts/test/test-direct-tool-guide-cleanup-secondary.ts

Comment thread data/tool-guides/aesthetic-quality-guide.md
Comment thread data/tool-guides/object-assembly-guide.md
Comment thread scripts/test/test-direct-tool-guide-cleanup-secondary.ts
@github-actions github-actions Bot removed the desktop label May 17, 2026
@Ker102 Ker102 merged commit dc9ac20 into main May 17, 2026
5 of 6 checks passed
@Ker102 Ker102 deleted the feature/direct-tool-guide-cleanup-2 branch May 17, 2026 19:57
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 scripts

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant