Dogfood a repo architecture diagram into TECHNICAL.md; fix arch alt reproducibility - #17
Merged
Merged
Conversation
…eproducibility Runs codeshot's own --embed on codeshot: a whole-repo file-dependency diagram (docs/architecture.svg) embedded into TECHNICAL.md via the codeshot:arch marker block, refreshable in place with codeshot --architecture --path . --embed TECHNICAL.md --format svg --out docs/architecture.svg Fix surfaced by dogfooding: the --architecture embed's alt text was derived from the checkout directory's basename, so the committed markdown varied by where the repo was cloned (a bare-worktree dir, "master", a branch name...). That both read wrong and broke --check portability — a fresh clone under a different dir name would report the committed diagram as drifted. The alt is now the fixed, path-independent "Architecture — generated by codeshot" (the repo name is redundant; the diagram already lives in that repo's own doc). Pinned by a test assertion. Tests: 75 passed; --check verified green against the committed diagram.
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
1 participant
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.
What
Uses codeshot's own
--embedto add a whole-repo file-dependency diagram (docs/architecture.svg) toTECHNICAL.md, refreshable in place via thecodeshot:archmarker block.Fix surfaced by dogfooding
The
--architectureembed's alt text was derived from the checkout directory's basename — so the committed markdown varied by where the repo was cloned (a bare-worktree dir,master, a branch name…). That read wrong and broke--checkportability: a fresh clone under a different dir name would report the committed diagram as drifted.Now a fixed, path-independent
Architecture — generated by codeshot(the repo name is redundant — the diagram lives in that repo's own doc). Pinned by a test assertion.Verification
npm test→ 75 passed.--checkverified green against the committed diagram (up to date).🤖 Generated with Claude Code