Skip to content

docs(readme): lead with what the pack does for an AI agent, and how to install it - #427

Merged
TMHSDigital merged 1 commit into
mainfrom
docs/readme-first-screen
Oct 5, 2026
Merged

TMHSDigital merged 1 commit into
mainfrom
docs/readme-first-screen

Conversation

@TMHSDigital

Copy link
Copy Markdown
Owner

Closes #370.

Before → after (first screen)

Evidence (local)

  • python tests/check_counts.py: Counts verified in 5 docs. The counts line and Overview sentence are untouched.
  • The Validate "Claude Code packaging" step, extracted and run locally: Claude Code packaging verified.
  • build_plugin_dist.py --check: ok.

🤖 Generated with Claude Code

@TMHSDigital

Copy link
Copy Markdown
Owner Author

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

@TMHSDigital
TMHSDigital force-pushed the docs/readme-first-screen branch from acffb5e to 91c5d84 Compare October 5, 2026 00:36
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 5, 2026
@TMHSDigital
TMHSDigital force-pushed the docs/readme-first-screen branch 2 times, most recently from 9f7b65d to 8a3af26 Compare October 5, 2026 00:47
@TMHSDigital

Copy link
Copy Markdown
Owner Author

CI evidence before merge: all checks pass ( 13 pass ). Blender Smoke on PR head: Blender 5.2.2 LTS / Blender 4.5.14 LTS. Summaries (happy path; falsifiers) per leg: 143 passed, 1 skipped, 0 failed;143 passed, 0 skipped, 0 failed;141 passed, 3 skipped, 0 failed;136 passed, 7 skipped, 0 failed;

@TMHSDigital
TMHSDigital force-pushed the docs/readme-first-screen branch from 8a3af26 to 28bb5f6 Compare October 5, 2026 01:27
…o install it

The README opened with "Skills, rules, snippets, templates, and runnable
examples for Blender Python development" and three rows of badges, so a
visitor could not tell in ten seconds that this is an agent pack; the
Claude Code /plugin listing described it as "Cursor and Claude Code
skills ..." with no outcome.

The first screen now states the outcome, names three failures the pack
prevents (each one measured in this repo: context.copy() overrides,
action.fcurves on 5.x, Z-up glTF), shows the two-line Claude Code
install, and keeps one badge row; the license badge shows the MIT carve
out for code. The Overview no longer says Cursor takes skills "by name
in chat". The Claude plugin and marketplace descriptions are
outcome-first. Counts wording is unchanged (validate-counts greps it).

Closes #370

Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@TMHSDigital
TMHSDigital force-pushed the docs/readme-first-screen branch from 28bb5f6 to 2cb165a Compare October 5, 2026 01:37
@TMHSDigital

Copy link
Copy Markdown
Owner Author

CI evidence before merge: all checks pass ( 13 pass ). Blender Smoke on PR head: Blender 5.2.2 LTS / Blender 4.5.14 LTS. Summaries (happy path; falsifiers) per leg: 143 passed, 1 skipped, 0 failed;143 passed, 0 skipped, 0 failed;141 passed, 3 skipped, 0 failed;136 passed, 7 skipped, 0 failed;

@TMHSDigital
TMHSDigital merged commit 3bc4949 into main Oct 5, 2026
13 checks passed
@TMHSDigital
TMHSDigital deleted the docs/readme-first-screen branch October 5, 2026 01:55
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.

marketing: README first screen and plugin description don't say what the pack does for an AI agent

1 participant