Skip to content

docs(showcase): say what the showcase proves, not only what it is not - #436

Merged
TMHSDigital merged 1 commit into
mainfrom
docs/showcase-purpose
Oct 5, 2026
Merged

TMHSDigital merged 1 commit into
mainfrom
docs/showcase-purpose

Conversation

@TMHSDigital

Copy link
Copy Markdown
Owner

Closes #383.

The README described the 76 pieces only as "budget-conformance props … not examples". This adds the why in three places:

  • the README layer table;
  • the README Examples and showcase section;
  • a new "Why it is here" paragraph in showcase/README.md.

Each piece is one headless script that runs the pipeline the skills teach (cleanup, high-to-low bake, LODs, convex collider, engine export) and asserts measured budgets on every LTS. So it's evidence that the skills compose, and a piece fails if a skill's advice is wrong (#386 is a live case).

The landing page already says this ("compose shipped skills into a recognizable asset"), so it is unchanged. I avoided claiming who or what authored the pieces. Docs only; check_counts.py passes.

🤖 Generated with Claude Code

The README listed "76 showcase pieces" next to skills and rules and
described them only as "budget-conformance props ... not examples", so a
first-time visitor could read the repo as an asset pack. The README
overview, the examples section and showcase/README.md now say why the
showcase exists: each piece is one headless script that runs the
pipeline the skills teach (cleanup, bake, LODs, collider, engine export)
end to end and asserts measured budgets on every LTS, so it is evidence
that the skills compose. The landing page already framed it this way.

Closes #383

Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the showcase Budget-conformance props under showcase/ label Oct 5, 2026
@TMHSDigital
TMHSDigital force-pushed the docs/showcase-purpose branch from 2bc3c0c to cef8073 Compare October 5, 2026 01:53
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 5, 2026
@TMHSDigital

Copy link
Copy Markdown
Owner Author

CI evidence before merge: all checks pass ( 10 pass ). No Blender Smoke run (paths-ignore: docs-only).

@TMHSDigital
TMHSDigital merged commit 4b3b787 into main Oct 5, 2026
10 checks passed
@TMHSDigital
TMHSDigital deleted the docs/showcase-purpose branch October 5, 2026 01:59
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 showcase Budget-conformance props under showcase/

Projects

None yet

Development

Successfully merging this pull request may close these issues.

marketing: clarify what the 76-piece showcase is for (evidence, not an asset pack)

1 participant