docs: consolidate duplicated explanations and trim slop#3494
Merged
Conversation
Give each mechanism one home: template-append (llm-commits guide), -vv diagnostic files (wt config state logs), fsmonitor/trash cleanup (FAQ inventory), copy-ignored built-in excludes (wt step copy-ignored), hook-types table (wt hook). Other mentions link instead of restating. Shrink the deprecated ci-status section to a pointer, dissolve copy-ignored's Features list into the sections owning its facts, drop the four 'Note: experimental' lines redundant with the badge, and cut SKILL.md's duplicated permission-model and hook-mapping sections plus in-distribution scaffolding (339 to 181 lines). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
worktrunk-bot
approved these changes
Jul 16, 2026
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.
Sweep of the docs for repetition and filler, from an audit of the hand-authored pages, the command pages' source in
src/cli/mod.rs, and the plugin skill. Net −574 lines; every cut either had a surviving canonical home or restated an adjacent sentence.One home per mechanism (other mentions now link to it):
template-append— the LLM commits guide owns the rendering mechanism; the user- and project-config sections keep the key, an example, and what is unique to them (the project approval gate and the only-template-append-from-project scoping). Was explained in full in three places.-vvdiagnostic files —wt config state logsowns the four file descriptions; the FAQ summarizes in one sentence and links.wt removebullets merge into one that distinguishes own-daemon teardown from the orphan sweep; troubleshooting.md's restatement compresses to a pointer, keeping its unique wedged-daemon-on-live-worktree guidance.wt step copy-ignoredpage owns the directory list (previously enumerated 4×); the config sections state the rule and link.wt hookowns it; the extending guide replaces its verbatim copy with a sentence.test_llm_docs_commands_match_config_example, so it cannot drift.Cut-over debt: the deprecated
wt config state ci-statussection shrinks to a deprecation pointer — its status table, fetch order, and caching notes all duplicated thewt listCI-status section.Structure:
wt step copy-ignored's "Features" list dissolves into the sections that owned its facts (excludes → "What gets copied", reflink → "Performance"); the four trailing "Note: This command is experimental…" lines go (the[experimental]badge already appears twice per section); shell-integration.md described the directive-file mechanism twice and now describes it once.SKILL.md drops from 339 to 181 lines: the permission-model section duplicated the config-types bullets, the hook-type mapping appeared twice, and the "Determining Which Config to Use" / "Validation Before Adding Commands" scaffolding enumerated judgments an agent makes on its own. The approvals-escalation and agent-handoff sections are untouched.
Deliberately not addressed:
wt list's schema 1 JSON tables (still the default schema; the wholesale deletion lands when the default flips) and corpus-wide em-dash density (a house-style decision, not a per-page fix).Generated mirrors (docs command pages, skill references, plugins mirror,
dev/*.example.toml, help snapshots) regenerated viatest_docs_are_in_syncandcargo insta.