docs(claude): scope the generated-mirror rule to the files that are mirrors#3468
Draft
max-sixty wants to merge 1 commit into
Draft
docs(claude): scope the generated-mirror rule to the files that are mirrors#3468max-sixty wants to merge 1 commit into
max-sixty wants to merge 1 commit into
Conversation
…irrors The Documentation section read as "everything under docs/content/, skills/worktrunk/reference/, and plugins/worktrunk/skills/ is generated", but two of those directories also hold hand-edited primaries: non-command docs in docs/content/ and skill-only pages (shell-integration.md, troubleshooting.md) in the reference dir. Only plugins/worktrunk/skills/ is wholly generated. Name the split so the sentence stops steering edits away from legitimate source files. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
The Documentation section of
CLAUDE.mdsaid "never hand-edit the generated mirrors underdocs/content/,skills/worktrunk/reference/, orplugins/worktrunk/skills/", which reads as "everything under these directories is generated." That's wrong for two of the three:docs/content/— non-command docs (faq, tips-patterns, worktrunk, claude-code, llm-commits) are hand-edited primaries; only command pages have generated regions.skills/worktrunk/reference/—shell-integration.md,troubleshooting.md, andREADME.mdare hand-maintained sources (already carved out in.gitattributeswithlinguist-generated=false); the rest are generated mirrors.plugins/worktrunk/skills/— wholly generated, as stated.The over-broad wording nearly steered #3455 away from editing
shell-integration.md, which was the correct file to edit. The reworded sentence names the split per directory and defers todocs/CLAUDE.md's sync taxonomy (already linked at the end of the paragraph) for the per-file answer. No behavior or generated-file changes.🤖 Generated with Claude Code