Skip to content

fix: review polish for the four newest examples + documentation currency#51

Merged
TMHSDigital merged 1 commit into
mainfrom
fix/review-polish
Jul 3, 2026
Merged

fix: review polish for the four newest examples + documentation currency#51
TMHSDigital merged 1 commit into
mainfrom
fix/review-polish

Conversation

@TMHSDigital

Copy link
Copy Markdown
Owner

Summary

Follow-up to the review of the four auto-generated examples, plus a docs currency audit.

Example fixes

  • gn-instance-grid / temp-override-join: reframed (right column / top step were clipped); heroes + previews re-rendered.
  • temp-override-join: removed the redundant select_set/active setup — the override alone fabricates the context, which is the point being taught; the docstring now says so.
  • curve-bevel-arc: the measured vert/face constants are now honestly labeled as a measured regression gate (with re-measure instructions) instead of claimed closed-form.

Documentation currency — examples were absent from every core doc:

  • CLAUDE.md: architecture block (+examples/scripts/docs-gallery), new Examples (12) section with the authoring + wiring contract, release-hygiene and workflow updates.
  • AGENTS.md: content base de-pinned from "as of v0.2.0" (+examples bullet), structure block, and blender-smoke.yml documented in CI/CD.
  • README: header/badges/overview count 12 examples (load-bearing counts language verified intact).
  • ROADMAP: obsolete fleet lift-and-shift candidate marked resolved-differently (vendored locally per the no-metarepo decision).

Testing

Both touched examples re-verified headless on Blender 5.1.1 and 4.4.3; gallery regenerated (12 detail pages); README counts grep-verified.

🤖 Generated with Claude Code

Example fixes from review of the auto-generated batch:
- gn-instance-grid and temp-override-join reframed — the right cube
  column and the top step were clipped at the frame edge; both now sit
  fully in frame with margin (heroes and previews re-rendered)
- temp-override-join drops the redundant select_set/active-object setup:
  the temp_override alone fabricates the operator context, which is the
  contract the example teaches
- curve-bevel-arc stops calling its vert/face constants closed-form:
  they are labeled as a measured regression gate with re-measure
  instructions (curve tessellation has no simple formula)

Documentation currency (examples existed nowhere in the core docs):
- CLAUDE.md: examples/scripts/docs-gallery in the architecture block, a
  new Examples (12) section with the authoring/wiring contract, examples
  in release-hygiene step 1, site-generation note in the workflow section
- AGENTS.md: content-base list de-pinned from 'as of v0.2.0' and gains
  the examples bullet, structure block gains examples/scripts/docs
  entries, blender-smoke.yml documented in CI/CD
- README: header, badge row, and overview now count 12 examples
  (validate-counts language preserved)
- ROADMAP: the fleet-template lift-and-shift candidate marked resolved
  differently — vendored locally, gallery.json is permanent

Both touched examples re-verified headless on Blender 5.1.1 and 4.4.3.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 3, 2026
@TMHSDigital TMHSDigital merged commit 0df86fb into main Jul 3, 2026
9 checks passed
@TMHSDigital TMHSDigital deleted the fix/review-polish branch July 3, 2026 23:04
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant