* feat(skill): replace skill-pack with per-harness conditional compiler
skillbuild compiles the skill tree into per-target harness builds:
- <!-- skill:if omp,!claude --> blocks include text only for matching
targets; name-list conditions only, no else/nesting, fail-loud on
unknown targets and unpaired/nested directives
- fence-aware: directive-looking lines inside code fences are literal
- layout is the filesystem; tree root configured in skillproj.toml
- post-build assertion: zero directive residue, SKILL.md frontmatter
name check
Migration to the new model:
- docs/skill/ becomes the self-contained source root (SKILL.md,
references/, generated api/stdlib/core/guides now under
references/docs/; SDK_OVERVIEW/LICENSE/inspect are ordinary tree
files)
- auto_docs_gen output redirected into the tree (docs/api ->
docs/skill/references/docs/api, likewise stdlib)
- skills/simplecadapi/ is now the compiled omp target output;
dist/generic/simplecadapi the generic target
- dropped skill-pack entry point (plus dangling evolve/make-export
entries and their orphaned test), release workflow builds via
skillbuild + tar; README updated
First real conditional block: harness reading paths in SKILL.md
(skill:// mount on omp vs disk-relative on generic).
Verified: 59 tests pass (skillbuild 31, auto_docs_gen 19, persistence
regression 9); both targets build; outputs residue-clean; full suite
collects (1376 tests).
* refactor(tools): auto_docs_gen moves out of the installed package
tools/ scripts are repo-checkout dev scripts, not packaged CLIs:
- auto_docs_gen.py now lives in tools/ beside the other generators;
auto_tools/ package removed entirely
- path resolution simplifies: repo root = parent of tools/, fail-loud
if pyproject.toml missing; site-packages/cwd fallback branches were
dead code once the script stopped shipping in the wheel
- auto-docs-gen console script dropped from [project.scripts];
release.yml and README invoke python tools/auto_docs_gen.py
- MANIFEST.in stale src/auto_tools include removed; CadQuery-free
runtime scan no longer needs the auto_tools filter
- run_examples.py retired (user removal): README example-runner text
updated to direct examples/ scripts; dangling runner-contract test
(runpy.run_path into the deleted script) removed
Verified: 53 tests pass (auto_docs_gen + skill_build + ocp runtime
scan) and test_example_model_contract passes; regeneration from
tools/ is byte-identical (zero docs drift).
* refactor(skill): strip harness and build-tool content from the skill tree
The skill is plain harness-neutral content again:
- SKILL.md 'Reading skill files' section removed (the omp skill://
mount block and its !omp complement were the only conditional
blocks; the tree compiles identically for every target now)
- references/README.md: build-tool meta removed ('per-harness
conditional compilation', skillbuild packaging/validation claims —
link validation was never implemented, so the claim was false)
- live test now asserts the tree stays harness-neutral (zero blocks)
- skillproj.toml targets aligned with the user's output table
(omp -> skills/simplecadapi-omp, opencode -> skills/simplecadapi-opencode;
leftover 'generic' entry had no output and failed the build)
- compiled outputs are regenerable artifacts: skills/simplecadapi/
untracked from git, skills/simplecadapi-*/ gitignored, release.yml
and README build via skillbuild and tar the omp output directly
(bsdtar has no --transform; inner dir keeps its suffixed name)
Verified: 49 tests pass; both targets build 372 files with zero
conditional blocks; no omp/conditional/directive residue in the tree
or outputs.
* chore(docs): drop stale architecture review and design notes
5.5 KiB
Discipline: Assembly Positioning
How SimpleCADAPI represents mating and motion intent, plus engineering guidance for choosing frames and placements.
Evidence labels
- SDK contract below describes behavior implemented by the public assembly, connector, placement, and solver APIs.
- Modeling guidance is a design recommendation. It is not automatically enforced by the SDK and must be reported as an assumption when it affects fit.
Core rule
Positioning is authored in source — part-local frames, connectors on leaf parts, placements, declarative constraints — and validated after solving. It is never eyeballed in a viewer and never patched into exported geometry.
The intent ladder
From weakest to strongest expression:
raw numeric placement
→ placement tied to a named datum/offset/clearance
→ connector frames on leaf parts (mating interface as data)
→ declarative constraints (fixed/revolute/prismatic/gear/rack-pinion/belt)
→ grounded root + solved constraint graph
Use the strongest expression the relationship actually has. A lid seated on a base with a gasket gap is a constraint-bearing relationship, not a matrix.
Terminology
- Placement is a canonical right-handed frame created by
make_placement_rplacement(origin, x_axis=(1,0,0), y_axis=(0,1,0))oridentity_placement_rplacement(). Inputs are interpreted in the activeSimpleWorkplaneand transformed to global coordinates. The public API does not accept Euler, quaternion, or axis-angle payloads. - Connector is a named frame owned by a leaf part
(
add_connector_rpart,make_placement_connector_rconnector,make_edge_connector_rconnector,make_face_connector_rconnector,make_vertex_connector_rconnector). - Public connector is an interface declaration on an assembly
(
set_public_connector_rassembly): public id + direct-child component and connector reference. Declaring it does not clone, offset, or move geometry. When consumed through nested assemblies, the resolver follows nested public declarations to the source connector; it is not limited to one nesting level. - Constraint is the design relationship: flush, centered, coaxial, hinge-like, slider-like, gear mesh, rack drive, belt drive.
Choosing constraint types
| Relationship | Constraint |
|---|---|
| Fixed mounting, root grounding | add_fixed_constraint_rassembly / ground_component_rassembly |
| Hinge, pivot, rotational pose | add_revolute_constraint_rassembly |
| Slider, telescoping motion | add_prismatic_constraint_rassembly |
| Gear mesh (ratio, axes) | add_gear_constraint_rassembly |
| Rack and pinion | add_rack_pinion_constraint_rassembly |
| Belt/pulley relation | add_belt_constraint_rassembly |
Ground at least one component — the solver requires a grounded component to seed placements. Multiple grounded components are accepted, but can overconstrain the system or fail residual verification; ground exactly the components that are truly fixed in the product frame. Modeling guidance: when a body is authored away from the assembly origin, rotate it about its intended local axis before applying the translation. This avoids an unintended orbit around the assembly origin; it is a source construction choice, not a separate Placement API requirement. When a public connector declaration, source connector, or resolved frame changes, dependent interface hashes and builds are invalidated intentionally; that is dependency propagation, not a solver error.
Nesting
- Modeling guidance: group a functional unit (a bearing, gearbox stage, or fastener set) into a subassembly when it is placed, reasoned about, or repeated as a unit.
- A parent consumes a nested subassembly through its public connectors. The resolver can follow nested public declarations to the source connector, but a parent constraint does not automatically make an internal component independently movable. Author and solve the nested mechanism's own constraints first.
- Public ids are unique within their assembly. Changing a declaration, its source, or its resolved frame changes the interface hash and invalidates dependent builds.
Authoring workflow
- Choose the fixed/root component; ground it.
- Define part-local frames and datums before placing children
(
datums-and-coordinate-systems.md). - Attach connectors on leaf parts at functional datums.
- Compose with placements; declare public connectors where a parent will consume a subassembly.
- Add declarative constraints for mating and motion.
- Solve; read
AssemblySolveReport, residuals (measure_constraint_residual_rconstraintresidual), andinspect_assembly_constraints_rconstraintreport. - Validate placement outcomes with measurements, not impressions.
Positioning validation checklist
- Mating faces measure flush (or at the specified gap/offset).
- Screw/bore axes measure coaxial; X/Y positions match.
- Repeated parts share orientation; each occurrence lands at its named position.
- Moving a component changed placement only — its solid is untouched (compare volume/bounds before and after if in doubt).
- Solve residuals within tolerance; hits/misses match expectations.
When a check fails
Fix in source, in this order of likelihood: part-local origin or datum; connector frame definition; placement translation/rotation; constraint reference (wrong component or connector); missing or conflicting constraint; assembly hierarchy. Then re-solve and re-validate. Never patch the solved output.