Skip to content

docs: README quality-of-life pass (collapsible examples, quick start, nav)#63

Merged
TMHSDigital merged 1 commit into
mainfrom
docs/readme-qol-pass
Jul 19, 2026
Merged

docs: README quality-of-life pass (collapsible examples, quick start, nav)#63
TMHSDigital merged 1 commit into
mainfrom
docs/readme-qol-pass

Conversation

@TMHSDigital

Copy link
Copy Markdown
Owner

Restructures the README for first-time visitors while preserving all CI-enforced counts language and every example blurb.

  • Collapsible example categories: the ~300-line examples table is now five themed <details> groups (Materials/shading/compositing ×5, Mesh/curves/text ×6, Geometry Nodes ×2, Animation/rigging/constraints ×5, Context/Grease Pencil ×2 — all 20 present exactly once, validated by script).
  • Visible teaser row of four gallery thumbnails above the fold so the page still leads with renders when groups are collapsed.
  • Nav strip under the badges (Gallery, Quick start, Examples, Skills, Rules, Templates, Snippets, Roadmap).
  • Quick start section: clone, Cursor/Claude Code consumption, and a copy-paste headless example run.
  • New badge for the Blender 4.5 + 5.1 smoke workflow.
  • Roadmap section refreshed (old text referenced v0.2.0/v0.3.0; repo is at v0.17.x) and a Contributing section linking CONTRIBUTING/SECURITY/CODE_OF_CONDUCT and the new docs/VISUAL-STYLE.md.
  • Aligned the grease-pencil README blurb with the corrected frames.new(1) card copy from the audit passes.

Verified: counts substrings ("12 skills", "6 rules", "2 templates", "17 snippets") intact for validate-counts; all image paths exist; details/summary/table tags balanced.

🤖 Generated with Claude Code

…uick start, nav strip

The 20-example table was a ~300-line wall between the fold and the usage
docs. Examples now sit in five themed collapsible groups behind a visible
four-thumbnail teaser, with a nav strip, a quick-start section, a smoke-test
badge, a refreshed roadmap blurb, and a contributing section. Card copy is
unchanged except aligning the grease-pencil blurb with the corrected
frames.new(1) card. CI-enforced counts language preserved verbatim.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 19, 2026
@TMHSDigital
TMHSDigital merged commit 6f199ef into main Jul 19, 2026
9 checks passed
@TMHSDigital
TMHSDigital deleted the docs/readme-qol-pass branch July 19, 2026 01:24
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