Add CLAUDE.md with architecture and workflow guidance - #11
Closed
BenCaunt wants to merge 1 commit into
Closed
Conversation
Documents the build-registry-driven design, project layout convention, shared CAD library, inspection/review pipeline, URDF generation, and the done criteria for CAD changes so future Claude sessions can be productive without re-deriving them.
Contributor
SynthCAD CAD reviewCompared |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a root
CLAUDE.mdso future Claude Code sessions can be productive in this repo without re-deriving its conventions from source.The doc covers:
readlinepytest workaround that mirrors.github/workflows/synthcad-ci.yml.BUILD_TARGETSregistry insynthcad/build.pyas the single source of truth that every CLI reads; the dual project layout (synthcad/projects/<slug>/for source vs.projects/<slug>/forreal-parts/,docs/,tests/,generated/); sharedsynthcad/cad/andsynthcad/library/primitives; the.brepcache layer insynthcad/external_parts.py; the inspection / review-asset / PR diff pipeline; and URDF handoff conventions.skills/bundles.Generic development advice is intentionally omitted to keep the file focused on what requires reading multiple modules to discover.
Test plan
CLAUDE.mdrenders correctly on GitHubpyproject.toml[project.scripts]synthcad/andprojects/Generated by Claude Code