docs: add CLAUDE.md with build commands and architecture guide#105
Open
jaballer wants to merge 1 commit into
Open
docs: add CLAUDE.md with build commands and architecture guide#105jaballer wants to merge 1 commit into
jaballer wants to merge 1 commit into
Conversation
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
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
CLAUDE.mdat the repo root to give Claude Code (and any new contributor) a fast, accurate mental model of the project. Focuses on the non-obvious things that require reading across multiple files.What it documents
ts-node(no build) vs. the full integration suite../dist/index.jsand hit the live Postmark API, so they require a priornpm run buildand real tokens intest/config/testing_keys.json. CI runs unit tests only.preview/isn't compiled — it's copied intodist/by thesyncPreviewstep, so preview edits need a rebuild.commandDirrouting (thin parent command via thecmd()helper → subcommand directory)..env('POSTMARK')mapping env vars into hidden yargs args, withvalidateToken()prompting as fallback;ServerClientvsAccountClient.meta.json+content.html/content.txt, layouts under_layouts/) and howpull/push/previewrevolve around it.log(),CommandResponse,fatalError).Notes
Documentation only — no source or behavior changes.