playground-examples

Community

Ship valid playground examples that pass all CI gates.

Authorandymai
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Contributing new or fixed examples to the brepjs browser-based CAD playground requires passing three strict validation gates (type checking, geometry meshing, and thumbnail generation), and missing any single gate breaks continuous integration or the public example gallery, creating a tedious, error-prone workflow for contributors.

Core Features & Use Cases

  • Full example authoring workflow: Guides contributors through adding new examples to the correct category file or registering new categories in the example barrel index.
  • Three-gate validation enforcement: Details exact commands, success criteria, and troubleshooting for each mandatory validation gate: type checking against ambient TypeScript definitions, geometry meshing via the OCCT kernel test harness, and committed .webp thumbnail generation for the public gallery.
  • Failure triage and edge case handling: Provides clear symptom-cause-fix mappings for common issues like stale ambient types, silent geometry fallback errors, missing thumbnails, and multi-body assembly connectivity checks.
  • Real-world use case: For example, if a contributor's new mechanical assembly example fails the geometry gate due to a silent fillet fallback, this skill guides them to replace the fallback pattern with unwrap() to ensure failures are caught during testing, and add the example to the connected body check list if it is a multi-body mechanism.

Quick Start

Use this skill to add or fix a brepjs playground example so it passes all three required validation gates and is ready for merge.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: playground-examples
Download link: https://github.com/andymai/brepjs/archive/main.zip#playground-examples

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 537,000+ vetted skills library on demand.